├── .changeset ├── config.json └── fuzzy-cows-approve.md ├── .eslintrc.js ├── .github └── workflows │ ├── check-docs.yml │ ├── create-release-pr.yml │ ├── publish.yml │ └── test.yml ├── .gitignore ├── .mocharc.js ├── .prettierrc ├── CHANGELOG.md ├── LICENSE ├── README.md ├── api-extractor.json ├── api-extractor.server.json ├── common └── api-review │ ├── generative-ai-server.api.md │ └── generative-ai.api.md ├── config └── api-extractor.json ├── docs ├── code-of-conduct.md ├── contributing.md └── reference │ ├── files │ ├── generative-ai.errordetails.__type_.md │ ├── generative-ai.errordetails.domain.md │ ├── generative-ai.errordetails.md │ ├── generative-ai.errordetails.metadata.md │ ├── generative-ai.errordetails.reason.md │ ├── generative-ai.filemetadata.displayname.md │ ├── generative-ai.filemetadata.md │ ├── generative-ai.filemetadata.mimetype.md │ ├── generative-ai.filemetadata.name.md │ ├── generative-ai.filemetadataresponse.createtime.md │ ├── generative-ai.filemetadataresponse.displayname.md │ ├── generative-ai.filemetadataresponse.error.md │ ├── generative-ai.filemetadataresponse.expirationtime.md │ ├── generative-ai.filemetadataresponse.md │ ├── generative-ai.filemetadataresponse.mimetype.md │ ├── generative-ai.filemetadataresponse.name.md │ ├── generative-ai.filemetadataresponse.sha256hash.md │ ├── generative-ai.filemetadataresponse.sizebytes.md │ ├── generative-ai.filemetadataresponse.state.md │ ├── generative-ai.filemetadataresponse.updatetime.md │ ├── generative-ai.filemetadataresponse.uri.md │ ├── generative-ai.filemetadataresponse.videometadata.md │ ├── generative-ai.filestate.md │ ├── generative-ai.googleaifilemanager._constructor_.md │ ├── generative-ai.googleaifilemanager.apikey.md │ ├── generative-ai.googleaifilemanager.deletefile.md │ ├── generative-ai.googleaifilemanager.getfile.md │ ├── generative-ai.googleaifilemanager.listfiles.md │ ├── generative-ai.googleaifilemanager.md │ ├── generative-ai.googleaifilemanager.uploadfile.md │ ├── generative-ai.listfilesresponse.files.md │ ├── generative-ai.listfilesresponse.md │ ├── generative-ai.listfilesresponse.nextpagetoken.md │ ├── generative-ai.listparams.md │ ├── generative-ai.listparams.pagesize.md │ ├── generative-ai.listparams.pagetoken.md │ ├── generative-ai.md │ ├── generative-ai.requestoptions.apiclient.md │ ├── generative-ai.requestoptions.apiversion.md │ ├── generative-ai.requestoptions.baseurl.md │ ├── generative-ai.requestoptions.customheaders.md │ ├── generative-ai.requestoptions.md │ ├── generative-ai.requestoptions.timeout.md │ ├── generative-ai.rpcstatus.code.md │ ├── generative-ai.rpcstatus.details.md │ ├── generative-ai.rpcstatus.md │ ├── generative-ai.rpcstatus.message.md │ ├── generative-ai.singlerequestoptions.md │ ├── generative-ai.singlerequestoptions.signal.md │ ├── generative-ai.uploadfileresponse.file.md │ ├── generative-ai.uploadfileresponse.md │ ├── generative-ai.videometadata.md │ ├── generative-ai.videometadata.videoduration.md │ └── index.md │ ├── main │ ├── generative-ai.arrayschema.items.md │ ├── generative-ai.arrayschema.maxitems.md │ ├── generative-ai.arrayschema.md │ ├── generative-ai.arrayschema.minitems.md │ ├── generative-ai.arrayschema.type.md │ ├── generative-ai.baseparams.generationconfig.md │ ├── generative-ai.baseparams.md │ ├── generative-ai.baseparams.safetysettings.md │ ├── generative-ai.batchembedcontentsrequest.md │ ├── generative-ai.batchembedcontentsrequest.requests.md │ ├── generative-ai.batchembedcontentsresponse.embeddings.md │ ├── generative-ai.batchembedcontentsresponse.md │ ├── generative-ai.blockreason.md │ ├── generative-ai.booleanschema.md │ ├── generative-ai.booleanschema.type.md │ ├── generative-ai.cachedcontent.createtime.md │ ├── generative-ai.cachedcontent.md │ ├── generative-ai.cachedcontent.name.md │ ├── generative-ai.cachedcontent.ttl.md │ ├── generative-ai.cachedcontent.updatetime.md │ ├── generative-ai.cachedcontentbase.contents.md │ ├── generative-ai.cachedcontentbase.displayname.md │ ├── generative-ai.cachedcontentbase.expiretime.md │ ├── generative-ai.cachedcontentbase.md │ ├── generative-ai.cachedcontentbase.model.md │ ├── generative-ai.cachedcontentbase.systeminstruction.md │ ├── generative-ai.cachedcontentbase.toolconfig.md │ ├── generative-ai.cachedcontentbase.tools.md │ ├── generative-ai.chatsession._constructor_.md │ ├── generative-ai.chatsession.gethistory.md │ ├── generative-ai.chatsession.md │ ├── generative-ai.chatsession.model.md │ ├── generative-ai.chatsession.params.md │ ├── generative-ai.chatsession.sendmessage.md │ ├── generative-ai.chatsession.sendmessagestream.md │ ├── generative-ai.citationmetadata.citationsources.md │ ├── generative-ai.citationmetadata.md │ ├── generative-ai.citationsource.endindex.md │ ├── generative-ai.citationsource.license.md │ ├── generative-ai.citationsource.md │ ├── generative-ai.citationsource.startindex.md │ ├── generative-ai.citationsource.uri.md │ ├── generative-ai.codeexecutionresult.md │ ├── generative-ai.codeexecutionresult.outcome.md │ ├── generative-ai.codeexecutionresult.output.md │ ├── generative-ai.codeexecutionresultpart.codeexecutionresult.md │ ├── generative-ai.codeexecutionresultpart.executablecode.md │ ├── generative-ai.codeexecutionresultpart.filedata.md │ ├── generative-ai.codeexecutionresultpart.functioncall.md │ ├── generative-ai.codeexecutionresultpart.functionresponse.md │ ├── generative-ai.codeexecutionresultpart.inlinedata.md │ ├── generative-ai.codeexecutionresultpart.md │ ├── generative-ai.codeexecutionresultpart.text.md │ ├── generative-ai.codeexecutiontool.codeexecution.md │ ├── generative-ai.codeexecutiontool.md │ ├── generative-ai.content.md │ ├── generative-ai.content.parts.md │ ├── generative-ai.content.role.md │ ├── generative-ai.contentembedding.md │ ├── generative-ai.contentembedding.values.md │ ├── generative-ai.counttokensrequest.contents.md │ ├── generative-ai.counttokensrequest.generatecontentrequest.md │ ├── generative-ai.counttokensrequest.md │ ├── generative-ai.counttokensresponse.md │ ├── generative-ai.counttokensresponse.totaltokens.md │ ├── generative-ai.dynamicretrievalconfig.dynamicthreshold.md │ ├── generative-ai.dynamicretrievalconfig.md │ ├── generative-ai.dynamicretrievalconfig.mode.md │ ├── generative-ai.dynamicretrievalmode.md │ ├── generative-ai.embedcontentrequest.content.md │ ├── generative-ai.embedcontentrequest.md │ ├── generative-ai.embedcontentrequest.tasktype.md │ ├── generative-ai.embedcontentrequest.title.md │ ├── generative-ai.embedcontentresponse.embedding.md │ ├── generative-ai.embedcontentresponse.md │ ├── generative-ai.enhancedgeneratecontentresponse.functioncall.md │ ├── generative-ai.enhancedgeneratecontentresponse.functioncalls.md │ ├── generative-ai.enhancedgeneratecontentresponse.md │ ├── generative-ai.enhancedgeneratecontentresponse.text.md │ ├── generative-ai.errordetails.__type_.md │ ├── generative-ai.errordetails.domain.md │ ├── generative-ai.errordetails.md │ ├── generative-ai.errordetails.metadata.md │ ├── generative-ai.errordetails.reason.md │ ├── generative-ai.executablecode.code.md │ ├── generative-ai.executablecode.language.md │ ├── generative-ai.executablecode.md │ ├── generative-ai.executablecodelanguage.md │ ├── generative-ai.executablecodepart.codeexecutionresult.md │ ├── generative-ai.executablecodepart.executablecode.md │ ├── generative-ai.executablecodepart.filedata.md │ ├── generative-ai.executablecodepart.functioncall.md │ ├── generative-ai.executablecodepart.functionresponse.md │ ├── generative-ai.executablecodepart.inlinedata.md │ ├── generative-ai.executablecodepart.md │ ├── generative-ai.executablecodepart.text.md │ ├── generative-ai.filedata.fileuri.md │ ├── generative-ai.filedata.md │ ├── generative-ai.filedata.mimetype.md │ ├── generative-ai.filedatapart.codeexecutionresult.md │ ├── generative-ai.filedatapart.executablecode.md │ ├── generative-ai.filedatapart.filedata.md │ ├── generative-ai.filedatapart.functioncall.md │ ├── generative-ai.filedatapart.functionresponse.md │ ├── generative-ai.filedatapart.inlinedata.md │ ├── generative-ai.filedatapart.md │ ├── generative-ai.filedatapart.text.md │ ├── generative-ai.finishreason.md │ ├── generative-ai.functioncall.args.md │ ├── generative-ai.functioncall.md │ ├── generative-ai.functioncall.name.md │ ├── generative-ai.functioncallingconfig.allowedfunctionnames.md │ ├── generative-ai.functioncallingconfig.md │ ├── generative-ai.functioncallingconfig.mode.md │ ├── generative-ai.functioncallingmode.md │ ├── generative-ai.functioncallpart.codeexecutionresult.md │ ├── generative-ai.functioncallpart.executablecode.md │ ├── generative-ai.functioncallpart.filedata.md │ ├── generative-ai.functioncallpart.functioncall.md │ ├── generative-ai.functioncallpart.functionresponse.md │ ├── generative-ai.functioncallpart.inlinedata.md │ ├── generative-ai.functioncallpart.md │ ├── generative-ai.functioncallpart.text.md │ ├── generative-ai.functiondeclaration.description.md │ ├── generative-ai.functiondeclaration.md │ ├── generative-ai.functiondeclaration.name.md │ ├── generative-ai.functiondeclaration.parameters.md │ ├── generative-ai.functiondeclarationschema.description.md │ ├── generative-ai.functiondeclarationschema.md │ ├── generative-ai.functiondeclarationschema.properties.md │ ├── generative-ai.functiondeclarationschema.required.md │ ├── generative-ai.functiondeclarationschema.type.md │ ├── generative-ai.functiondeclarationschemaproperty.md │ ├── generative-ai.functiondeclarationstool.functiondeclarations.md │ ├── generative-ai.functiondeclarationstool.md │ ├── generative-ai.functionresponse.md │ ├── generative-ai.functionresponse.name.md │ ├── generative-ai.functionresponse.response.md │ ├── generative-ai.functionresponsepart.codeexecutionresult.md │ ├── generative-ai.functionresponsepart.executablecode.md │ ├── generative-ai.functionresponsepart.filedata.md │ ├── generative-ai.functionresponsepart.functioncall.md │ ├── generative-ai.functionresponsepart.functionresponse.md │ ├── generative-ai.functionresponsepart.inlinedata.md │ ├── generative-ai.functionresponsepart.md │ ├── generative-ai.functionresponsepart.text.md │ ├── generative-ai.generatecontentcandidate.avglogprobs.md │ ├── generative-ai.generatecontentcandidate.citationmetadata.md │ ├── generative-ai.generatecontentcandidate.content.md │ ├── generative-ai.generatecontentcandidate.finishmessage.md │ ├── generative-ai.generatecontentcandidate.finishreason.md │ ├── generative-ai.generatecontentcandidate.groundingmetadata.md │ ├── generative-ai.generatecontentcandidate.index.md │ ├── generative-ai.generatecontentcandidate.logprobsresult.md │ ├── generative-ai.generatecontentcandidate.md │ ├── generative-ai.generatecontentcandidate.safetyratings.md │ ├── generative-ai.generatecontentrequest.cachedcontent.md │ ├── generative-ai.generatecontentrequest.contents.md │ ├── generative-ai.generatecontentrequest.md │ ├── generative-ai.generatecontentrequest.systeminstruction.md │ ├── generative-ai.generatecontentrequest.toolconfig.md │ ├── generative-ai.generatecontentrequest.tools.md │ ├── generative-ai.generatecontentresponse.candidates.md │ ├── generative-ai.generatecontentresponse.md │ ├── generative-ai.generatecontentresponse.promptfeedback.md │ ├── generative-ai.generatecontentresponse.usagemetadata.md │ ├── generative-ai.generatecontentresult.md │ ├── generative-ai.generatecontentresult.response.md │ ├── generative-ai.generatecontentstreamresult.md │ ├── generative-ai.generatecontentstreamresult.response.md │ ├── generative-ai.generatecontentstreamresult.stream.md │ ├── generative-ai.generationconfig.candidatecount.md │ ├── generative-ai.generationconfig.frequencypenalty.md │ ├── generative-ai.generationconfig.logprobs.md │ ├── generative-ai.generationconfig.maxoutputtokens.md │ ├── generative-ai.generationconfig.md │ ├── generative-ai.generationconfig.presencepenalty.md │ ├── generative-ai.generationconfig.responselogprobs.md │ ├── generative-ai.generationconfig.responsemimetype.md │ ├── generative-ai.generationconfig.responseschema.md │ ├── generative-ai.generationconfig.stopsequences.md │ ├── generative-ai.generationconfig.temperature.md │ ├── generative-ai.generationconfig.topk.md │ ├── generative-ai.generationconfig.topp.md │ ├── generative-ai.generativecontentblob.data.md │ ├── generative-ai.generativecontentblob.md │ ├── generative-ai.generativecontentblob.mimetype.md │ ├── generative-ai.generativemodel._constructor_.md │ ├── generative-ai.generativemodel.apikey.md │ ├── generative-ai.generativemodel.batchembedcontents.md │ ├── generative-ai.generativemodel.cachedcontent.md │ ├── generative-ai.generativemodel.counttokens.md │ ├── generative-ai.generativemodel.embedcontent.md │ ├── generative-ai.generativemodel.generatecontent.md │ ├── generative-ai.generativemodel.generatecontentstream.md │ ├── generative-ai.generativemodel.generationconfig.md │ ├── generative-ai.generativemodel.md │ ├── generative-ai.generativemodel.model.md │ ├── generative-ai.generativemodel.safetysettings.md │ ├── generative-ai.generativemodel.startchat.md │ ├── generative-ai.generativemodel.systeminstruction.md │ ├── generative-ai.generativemodel.toolconfig.md │ ├── generative-ai.generativemodel.tools.md │ ├── generative-ai.googlegenerativeai._constructor_.md │ ├── generative-ai.googlegenerativeai.apikey.md │ ├── generative-ai.googlegenerativeai.getgenerativemodel.md │ ├── generative-ai.googlegenerativeai.getgenerativemodelfromcachedcontent.md │ ├── generative-ai.googlegenerativeai.md │ ├── generative-ai.googlegenerativeaiaborterror.md │ ├── generative-ai.googlegenerativeaierror._constructor_.md │ ├── generative-ai.googlegenerativeaierror.md │ ├── generative-ai.googlegenerativeaifetcherror._constructor_.md │ ├── generative-ai.googlegenerativeaifetcherror.errordetails.md │ ├── generative-ai.googlegenerativeaifetcherror.md │ ├── generative-ai.googlegenerativeaifetcherror.status.md │ ├── generative-ai.googlegenerativeaifetcherror.statustext.md │ ├── generative-ai.googlegenerativeairequestinputerror.md │ ├── generative-ai.googlegenerativeairesponseerror._constructor_.md │ ├── generative-ai.googlegenerativeairesponseerror.md │ ├── generative-ai.googlegenerativeairesponseerror.response.md │ ├── generative-ai.googlesearchretrieval.dynamicretrievalconfig.md │ ├── generative-ai.googlesearchretrieval.md │ ├── generative-ai.googlesearchretrievaltool.googlesearchretrieval.md │ ├── generative-ai.googlesearchretrievaltool.md │ ├── generative-ai.groundingchunk.md │ ├── generative-ai.groundingchunk.web.md │ ├── generative-ai.groundingchunkweb.md │ ├── generative-ai.groundingchunkweb.title.md │ ├── generative-ai.groundingchunkweb.uri.md │ ├── generative-ai.groundingmetadata.groundingchunks.md │ ├── generative-ai.groundingmetadata.groundingsupports.md │ ├── generative-ai.groundingmetadata.md │ ├── generative-ai.groundingmetadata.retrievalmetadata.md │ ├── generative-ai.groundingmetadata.searchentrypoint.md │ ├── generative-ai.groundingmetadata.websearchqueries.md │ ├── generative-ai.groundingsupport.confidencescores.md │ ├── generative-ai.groundingsupport.groundingchunckindices.md │ ├── generative-ai.groundingsupport.md │ ├── generative-ai.groundingsupport.segment.md │ ├── generative-ai.groundingsupportsegment.endindex.md │ ├── generative-ai.groundingsupportsegment.md │ ├── generative-ai.groundingsupportsegment.partindex.md │ ├── generative-ai.groundingsupportsegment.startindex.md │ ├── generative-ai.groundingsupportsegment.text.md │ ├── generative-ai.harmblockthreshold.md │ ├── generative-ai.harmcategory.md │ ├── generative-ai.harmprobability.md │ ├── generative-ai.inlinedatapart.codeexecutionresult.md │ ├── generative-ai.inlinedatapart.executablecode.md │ ├── generative-ai.inlinedatapart.filedata.md │ ├── generative-ai.inlinedatapart.functioncall.md │ ├── generative-ai.inlinedatapart.functionresponse.md │ ├── generative-ai.inlinedatapart.inlinedata.md │ ├── generative-ai.inlinedatapart.md │ ├── generative-ai.inlinedatapart.text.md │ ├── generative-ai.integerschema.format.md │ ├── generative-ai.integerschema.md │ ├── generative-ai.integerschema.type.md │ ├── generative-ai.logprobscandidate.logprobability.md │ ├── generative-ai.logprobscandidate.md │ ├── generative-ai.logprobscandidate.token.md │ ├── generative-ai.logprobscandidate.tokenid.md │ ├── generative-ai.logprobsresult.chosencandidates.md │ ├── generative-ai.logprobsresult.md │ ├── generative-ai.logprobsresult.topcandidates.md │ ├── generative-ai.md │ ├── generative-ai.modelparams.cachedcontent.md │ ├── generative-ai.modelparams.md │ ├── generative-ai.modelparams.model.md │ ├── generative-ai.modelparams.systeminstruction.md │ ├── generative-ai.modelparams.toolconfig.md │ ├── generative-ai.modelparams.tools.md │ ├── generative-ai.numberschema.format.md │ ├── generative-ai.numberschema.md │ ├── generative-ai.numberschema.type.md │ ├── generative-ai.objectschema.md │ ├── generative-ai.objectschema.properties.md │ ├── generative-ai.objectschema.required.md │ ├── generative-ai.objectschema.type.md │ ├── generative-ai.outcome.md │ ├── generative-ai.part.md │ ├── generative-ai.possible_roles.md │ ├── generative-ai.promptfeedback.blockreason.md │ ├── generative-ai.promptfeedback.blockreasonmessage.md │ ├── generative-ai.promptfeedback.md │ ├── generative-ai.promptfeedback.safetyratings.md │ ├── generative-ai.requestoptions.apiclient.md │ ├── generative-ai.requestoptions.apiversion.md │ ├── generative-ai.requestoptions.baseurl.md │ ├── generative-ai.requestoptions.customheaders.md │ ├── generative-ai.requestoptions.md │ ├── generative-ai.requestoptions.timeout.md │ ├── generative-ai.responseschema.md │ ├── generative-ai.retrievalmetadata.googlesearchdynamicretrievalscore.md │ ├── generative-ai.retrievalmetadata.md │ ├── generative-ai.safetyrating.category.md │ ├── generative-ai.safetyrating.md │ ├── generative-ai.safetyrating.probability.md │ ├── generative-ai.safetysetting.category.md │ ├── generative-ai.safetysetting.md │ ├── generative-ai.safetysetting.threshold.md │ ├── generative-ai.schema.md │ ├── generative-ai.schematype.md │ ├── generative-ai.searchentrypoint.md │ ├── generative-ai.searchentrypoint.renderedcontent.md │ ├── generative-ai.searchentrypoint.sdkblob.md │ ├── generative-ai.singlerequestoptions.md │ ├── generative-ai.singlerequestoptions.signal.md │ ├── generative-ai.startchatparams.cachedcontent.md │ ├── generative-ai.startchatparams.history.md │ ├── generative-ai.startchatparams.md │ ├── generative-ai.startchatparams.systeminstruction.md │ ├── generative-ai.startchatparams.toolconfig.md │ ├── generative-ai.startchatparams.tools.md │ ├── generative-ai.stringschema.enum.md │ ├── generative-ai.stringschema.md │ ├── generative-ai.stringschema.type.md │ ├── generative-ai.tasktype.md │ ├── generative-ai.textpart.codeexecutionresult.md │ ├── generative-ai.textpart.executablecode.md │ ├── generative-ai.textpart.filedata.md │ ├── generative-ai.textpart.functioncall.md │ ├── generative-ai.textpart.functionresponse.md │ ├── generative-ai.textpart.inlinedata.md │ ├── generative-ai.textpart.md │ ├── generative-ai.textpart.text.md │ ├── generative-ai.tool.md │ ├── generative-ai.toolconfig.functioncallingconfig.md │ ├── generative-ai.toolconfig.md │ ├── generative-ai.topcandidates.candidates.md │ ├── generative-ai.topcandidates.md │ ├── generative-ai.usagemetadata.cachedcontenttokencount.md │ ├── generative-ai.usagemetadata.candidatestokencount.md │ ├── generative-ai.usagemetadata.md │ ├── generative-ai.usagemetadata.prompttokencount.md │ ├── generative-ai.usagemetadata.totaltokencount.md │ └── index.md │ └── server │ ├── generative-ai.arrayschema.items.md │ ├── generative-ai.arrayschema.maxitems.md │ ├── generative-ai.arrayschema.md │ ├── generative-ai.arrayschema.minitems.md │ ├── generative-ai.arrayschema.type.md │ ├── generative-ai.booleanschema.md │ ├── generative-ai.booleanschema.type.md │ ├── generative-ai.cachedcontent.createtime.md │ ├── generative-ai.cachedcontent.md │ ├── generative-ai.cachedcontent.name.md │ ├── generative-ai.cachedcontent.ttl.md │ ├── generative-ai.cachedcontent.updatetime.md │ ├── generative-ai.cachedcontentbase.contents.md │ ├── generative-ai.cachedcontentbase.displayname.md │ ├── generative-ai.cachedcontentbase.expiretime.md │ ├── generative-ai.cachedcontentbase.md │ ├── generative-ai.cachedcontentbase.model.md │ ├── generative-ai.cachedcontentbase.systeminstruction.md │ ├── generative-ai.cachedcontentbase.toolconfig.md │ ├── generative-ai.cachedcontentbase.tools.md │ ├── generative-ai.cachedcontentcreateparams.md │ ├── generative-ai.cachedcontentcreateparams.ttlseconds.md │ ├── generative-ai.cachedcontentupdateinputfields.expiretime.md │ ├── generative-ai.cachedcontentupdateinputfields.md │ ├── generative-ai.cachedcontentupdateinputfields.ttlseconds.md │ ├── generative-ai.cachedcontentupdateparams.cachedcontent.md │ ├── generative-ai.cachedcontentupdateparams.md │ ├── generative-ai.cachedcontentupdateparams.updatemask.md │ ├── generative-ai.codeexecutionresult.md │ ├── generative-ai.codeexecutionresult.outcome.md │ ├── generative-ai.codeexecutionresult.output.md │ ├── generative-ai.codeexecutionresultpart.codeexecutionresult.md │ ├── generative-ai.codeexecutionresultpart.executablecode.md │ ├── generative-ai.codeexecutionresultpart.filedata.md │ ├── generative-ai.codeexecutionresultpart.functioncall.md │ ├── generative-ai.codeexecutionresultpart.functionresponse.md │ ├── generative-ai.codeexecutionresultpart.inlinedata.md │ ├── generative-ai.codeexecutionresultpart.md │ ├── generative-ai.codeexecutionresultpart.text.md │ ├── generative-ai.codeexecutiontool.codeexecution.md │ ├── generative-ai.codeexecutiontool.md │ ├── generative-ai.content.md │ ├── generative-ai.content.parts.md │ ├── generative-ai.content.role.md │ ├── generative-ai.errordetails.__type_.md │ ├── generative-ai.errordetails.domain.md │ ├── generative-ai.errordetails.md │ ├── generative-ai.errordetails.metadata.md │ ├── generative-ai.errordetails.reason.md │ ├── generative-ai.executablecode.code.md │ ├── generative-ai.executablecode.language.md │ ├── generative-ai.executablecode.md │ ├── generative-ai.executablecodelanguage.md │ ├── generative-ai.executablecodepart.codeexecutionresult.md │ ├── generative-ai.executablecodepart.executablecode.md │ ├── generative-ai.executablecodepart.filedata.md │ ├── generative-ai.executablecodepart.functioncall.md │ ├── generative-ai.executablecodepart.functionresponse.md │ ├── generative-ai.executablecodepart.inlinedata.md │ ├── generative-ai.executablecodepart.md │ ├── generative-ai.executablecodepart.text.md │ ├── generative-ai.filedata.fileuri.md │ ├── generative-ai.filedata.md │ ├── generative-ai.filedata.mimetype.md │ ├── generative-ai.filedatapart.codeexecutionresult.md │ ├── generative-ai.filedatapart.executablecode.md │ ├── generative-ai.filedatapart.filedata.md │ ├── generative-ai.filedatapart.functioncall.md │ ├── generative-ai.filedatapart.functionresponse.md │ ├── generative-ai.filedatapart.inlinedata.md │ ├── generative-ai.filedatapart.md │ ├── generative-ai.filedatapart.text.md │ ├── generative-ai.filemetadata.displayname.md │ ├── generative-ai.filemetadata.md │ ├── generative-ai.filemetadata.mimetype.md │ ├── generative-ai.filemetadata.name.md │ ├── generative-ai.filemetadataresponse.createtime.md │ ├── generative-ai.filemetadataresponse.displayname.md │ ├── generative-ai.filemetadataresponse.error.md │ ├── generative-ai.filemetadataresponse.expirationtime.md │ ├── generative-ai.filemetadataresponse.md │ ├── generative-ai.filemetadataresponse.mimetype.md │ ├── generative-ai.filemetadataresponse.name.md │ ├── generative-ai.filemetadataresponse.sha256hash.md │ ├── generative-ai.filemetadataresponse.sizebytes.md │ ├── generative-ai.filemetadataresponse.state.md │ ├── generative-ai.filemetadataresponse.updatetime.md │ ├── generative-ai.filemetadataresponse.uri.md │ ├── generative-ai.filemetadataresponse.videometadata.md │ ├── generative-ai.filestate.md │ ├── generative-ai.functioncall.args.md │ ├── generative-ai.functioncall.md │ ├── generative-ai.functioncall.name.md │ ├── generative-ai.functioncallingconfig.allowedfunctionnames.md │ ├── generative-ai.functioncallingconfig.md │ ├── generative-ai.functioncallingconfig.mode.md │ ├── generative-ai.functioncallingmode.md │ ├── generative-ai.functioncallpart.codeexecutionresult.md │ ├── generative-ai.functioncallpart.executablecode.md │ ├── generative-ai.functioncallpart.filedata.md │ ├── generative-ai.functioncallpart.functioncall.md │ ├── generative-ai.functioncallpart.functionresponse.md │ ├── generative-ai.functioncallpart.inlinedata.md │ ├── generative-ai.functioncallpart.md │ ├── generative-ai.functioncallpart.text.md │ ├── generative-ai.functiondeclaration.description.md │ ├── generative-ai.functiondeclaration.md │ ├── generative-ai.functiondeclaration.name.md │ ├── generative-ai.functiondeclaration.parameters.md │ ├── generative-ai.functiondeclarationschema.description.md │ ├── generative-ai.functiondeclarationschema.md │ ├── generative-ai.functiondeclarationschema.properties.md │ ├── generative-ai.functiondeclarationschema.required.md │ ├── generative-ai.functiondeclarationschema.type.md │ ├── generative-ai.functiondeclarationschemaproperty.md │ ├── generative-ai.functiondeclarationstool.functiondeclarations.md │ ├── generative-ai.functiondeclarationstool.md │ ├── generative-ai.functionresponse.md │ ├── generative-ai.functionresponse.name.md │ ├── generative-ai.functionresponse.response.md │ ├── generative-ai.functionresponsepart.codeexecutionresult.md │ ├── generative-ai.functionresponsepart.executablecode.md │ ├── generative-ai.functionresponsepart.filedata.md │ ├── generative-ai.functionresponsepart.functioncall.md │ ├── generative-ai.functionresponsepart.functionresponse.md │ ├── generative-ai.functionresponsepart.inlinedata.md │ ├── generative-ai.functionresponsepart.md │ ├── generative-ai.functionresponsepart.text.md │ ├── generative-ai.generativecontentblob.data.md │ ├── generative-ai.generativecontentblob.md │ ├── generative-ai.generativecontentblob.mimetype.md │ ├── generative-ai.googleaicachemanager._constructor_.md │ ├── generative-ai.googleaicachemanager.apikey.md │ ├── generative-ai.googleaicachemanager.create.md │ ├── generative-ai.googleaicachemanager.delete.md │ ├── generative-ai.googleaicachemanager.get.md │ ├── generative-ai.googleaicachemanager.list.md │ ├── generative-ai.googleaicachemanager.md │ ├── generative-ai.googleaicachemanager.update.md │ ├── generative-ai.googleaifilemanager._constructor_.md │ ├── generative-ai.googleaifilemanager.apikey.md │ ├── generative-ai.googleaifilemanager.deletefile.md │ ├── generative-ai.googleaifilemanager.getfile.md │ ├── generative-ai.googleaifilemanager.listfiles.md │ ├── generative-ai.googleaifilemanager.md │ ├── generative-ai.googleaifilemanager.uploadfile.md │ ├── generative-ai.inlinedatapart.codeexecutionresult.md │ ├── generative-ai.inlinedatapart.executablecode.md │ ├── generative-ai.inlinedatapart.filedata.md │ ├── generative-ai.inlinedatapart.functioncall.md │ ├── generative-ai.inlinedatapart.functionresponse.md │ ├── generative-ai.inlinedatapart.inlinedata.md │ ├── generative-ai.inlinedatapart.md │ ├── generative-ai.inlinedatapart.text.md │ ├── generative-ai.integerschema.format.md │ ├── generative-ai.integerschema.md │ ├── generative-ai.integerschema.type.md │ ├── generative-ai.listcacheresponse.cachedcontents.md │ ├── generative-ai.listcacheresponse.md │ ├── generative-ai.listcacheresponse.nextpagetoken.md │ ├── generative-ai.listfilesresponse.files.md │ ├── generative-ai.listfilesresponse.md │ ├── generative-ai.listfilesresponse.nextpagetoken.md │ ├── generative-ai.listparams.md │ ├── generative-ai.listparams.pagesize.md │ ├── generative-ai.listparams.pagetoken.md │ ├── generative-ai.md │ ├── generative-ai.numberschema.format.md │ ├── generative-ai.numberschema.md │ ├── generative-ai.numberschema.type.md │ ├── generative-ai.objectschema.md │ ├── generative-ai.objectschema.properties.md │ ├── generative-ai.objectschema.required.md │ ├── generative-ai.objectschema.type.md │ ├── generative-ai.outcome.md │ ├── generative-ai.part.md │ ├── generative-ai.requestoptions.apiclient.md │ ├── generative-ai.requestoptions.apiversion.md │ ├── generative-ai.requestoptions.baseurl.md │ ├── generative-ai.requestoptions.customheaders.md │ ├── generative-ai.requestoptions.md │ ├── generative-ai.requestoptions.timeout.md │ ├── generative-ai.responseschema.md │ ├── generative-ai.rpcstatus.code.md │ ├── generative-ai.rpcstatus.details.md │ ├── generative-ai.rpcstatus.md │ ├── generative-ai.rpcstatus.message.md │ ├── generative-ai.schema.md │ ├── generative-ai.schematype.md │ ├── generative-ai.singlerequestoptions.md │ ├── generative-ai.singlerequestoptions.signal.md │ ├── generative-ai.stringschema.enum.md │ ├── generative-ai.stringschema.md │ ├── generative-ai.stringschema.type.md │ ├── generative-ai.textpart.codeexecutionresult.md │ ├── generative-ai.textpart.executablecode.md │ ├── generative-ai.textpart.filedata.md │ ├── generative-ai.textpart.functioncall.md │ ├── generative-ai.textpart.functionresponse.md │ ├── generative-ai.textpart.inlinedata.md │ ├── generative-ai.textpart.md │ ├── generative-ai.textpart.text.md │ ├── generative-ai.tool.md │ ├── generative-ai.toolconfig.functioncallingconfig.md │ ├── generative-ai.toolconfig.md │ ├── generative-ai.uploadfileresponse.file.md │ ├── generative-ai.uploadfileresponse.md │ ├── generative-ai.videometadata.md │ ├── generative-ai.videometadata.videoduration.md │ └── index.md ├── package-lock.json ├── package.json ├── rollup.config.mjs ├── samples ├── .eslintrc.cjs ├── README.md ├── api_version.js ├── cache.js ├── chat.js ├── code_execution.js ├── controlled_generation.js ├── count_tokens.js ├── embed.js ├── files.js ├── function_calling.js ├── log_prob.js ├── media │ ├── Big_Buck_Bunny.mp4 │ ├── a11.txt │ ├── firefighter.jpg │ ├── gemini.pdf │ ├── jetpack.jpg │ ├── piranha.jpg │ └── samplesmall.mp3 ├── model_configuration.js ├── package.json ├── safety_settings.js ├── search_grounding.js ├── system_instruction.js ├── text_generation.js ├── utils │ ├── check-samples.js │ ├── common.js │ └── insert-import-comments.js └── web │ ├── README.md │ ├── chat.html │ ├── favicon.svg │ ├── http-server.js │ ├── index.html │ ├── package.json │ └── utils │ ├── main.css │ └── shared.js ├── scripts ├── check-format.ts ├── format-patterns.ts ├── license.ts ├── license.txt └── run-format.ts ├── server └── package.json ├── src ├── errors.ts ├── gen-ai.test.ts ├── gen-ai.ts ├── index.ts ├── methods │ ├── chat-session-helpers.test.ts │ ├── chat-session-helpers.ts │ ├── chat-session.test.ts │ ├── chat-session.ts │ ├── count-tokens.ts │ ├── embed-content.ts │ ├── generate-content.test.ts │ └── generate-content.ts ├── models │ ├── generative-model.test.ts │ └── generative-model.ts ├── requests │ ├── request-helpers.test.ts │ ├── request-helpers.ts │ ├── request.test.ts │ ├── request.ts │ ├── response-helpers.test.ts │ ├── response-helpers.ts │ ├── stream-reader.test.ts │ └── stream-reader.ts └── server │ ├── cache-manager.test.ts │ ├── cache-manager.ts │ ├── constants.ts │ ├── file-manager.test.ts │ ├── file-manager.ts │ ├── index.ts │ ├── request.test.ts │ └── request.ts ├── test-integration ├── node │ ├── abort-signal.test.ts │ ├── cache-content.test.ts │ ├── count-tokens.test.ts │ ├── embed-content.test.ts │ ├── generate-content-multimodal.test.ts │ ├── generate-content-search-grounding.test.ts │ ├── generate-content-tools.test.ts │ ├── generate-content.test.ts │ ├── start-chat-tools.test.ts │ └── start-chat.test.ts └── web │ └── index.test.ts ├── test-utils ├── base64cat.ts ├── cat.jpeg ├── cat.png ├── mock-response.ts └── mock-responses │ ├── streaming-failure-empty-content.txt │ ├── streaming-failure-finish-reason-safety.txt │ ├── streaming-failure-prompt-blocked-safety.txt │ ├── streaming-failure-recitation-no-content.txt │ ├── streaming-success-basic-reply-long.txt │ ├── streaming-success-basic-reply-short.txt │ ├── streaming-success-citations.txt │ ├── streaming-success-function-call-short.txt │ ├── streaming-success-search-grounding.txt │ ├── streaming-success-utf8.txt │ ├── streaming-unknown-enum.txt │ ├── unary-failure-citations.json │ ├── unary-failure-empty-content.json │ ├── unary-failure-finish-reason-safety.json │ ├── unary-failure-image-rejected.json │ ├── unary-failure-prompt-blocked-safety.json │ ├── unary-success-basic-reply-long.json │ ├── unary-success-basic-reply-short.json │ ├── unary-success-citations.json │ ├── unary-success-logprobs.json │ ├── unary-success-search-grounding.json │ └── unary-unknown-enum.json ├── tsconfig.json ├── types ├── content.ts ├── enums.ts ├── function-calling.ts ├── index.ts ├── requests.ts ├── responses.ts ├── search-grounding.ts └── server │ ├── caching.ts │ ├── files.ts │ ├── index.ts │ └── shared.ts └── web-test-runner.config.mjs /.changeset/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json", 3 | "changelog": "@changesets/cli/changelog", 4 | "commit": false, 5 | "fixed": [], 6 | "linked": [], 7 | "access": "public", 8 | "baseBranch": "main", 9 | "updateInternalDependencies": "patch", 10 | "ignore": [], 11 | "snapshot": { 12 | "useCalculatedVersion": true 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /.changeset/fuzzy-cows-approve.md: -------------------------------------------------------------------------------- 1 | --- 2 | "@google/generative-ai": minor 3 | --- 4 | 5 | added support for buffers in uploadFile 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist/ 3 | temp/ 4 | *.tgz 5 | .DS_Store 6 | testfiles 7 | nodejs-vertexai/ 8 | samples/package-lock.json 9 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 80 3 | } -------------------------------------------------------------------------------- /api-extractor.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./config/api-extractor.json", 3 | "mainEntryPointFilePath": "/dist/src/index.d.ts", 4 | "apiReport": { 5 | "reportFileName": ".api.md" 6 | }, 7 | "dtsRollup": { 8 | "enabled": true, 9 | "untrimmedFilePath": "/dist/.d.ts" 10 | }, 11 | "docModel": { 12 | "enabled": true, 13 | "apiJsonFilePath": "/temp/main/.api.json" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /api-extractor.server.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./config/api-extractor.json", 3 | "mainEntryPointFilePath": "/dist/src/server/index.d.ts", 4 | "apiReport": { 5 | "reportFileName": "-server.api.md" 6 | }, 7 | "dtsRollup": { 8 | "enabled": true, 9 | "untrimmedFilePath": "/dist/server/server.d.ts" 10 | }, 11 | "docModel": { 12 | "enabled": true, 13 | "apiJsonFilePath": "/temp/server/-server.api.json" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.errordetails.__type_.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > ["@type"](./generative-ai.errordetails.__type_.md) 4 | 5 | ## ErrorDetails."@type" property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | "@type"?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.errordetails.domain.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [domain](./generative-ai.errordetails.domain.md) 4 | 5 | ## ErrorDetails.domain property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | domain?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.errordetails.metadata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [metadata](./generative-ai.errordetails.metadata.md) 4 | 5 | ## ErrorDetails.metadata property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | metadata?: Record; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.errordetails.reason.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [reason](./generative-ai.errordetails.reason.md) 4 | 5 | ## ErrorDetails.reason property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | reason?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadata.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [displayName](./generative-ai.filemetadata.displayname.md) 4 | 5 | ## FileMetadata.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadata.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [mimeType](./generative-ai.filemetadata.mimetype.md) 4 | 5 | ## FileMetadata.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadata.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [name](./generative-ai.filemetadata.name.md) 4 | 5 | ## FileMetadata.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.createtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [createTime](./generative-ai.filemetadataresponse.createtime.md) 4 | 5 | ## FileMetadataResponse.createTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | createTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [displayName](./generative-ai.filemetadataresponse.displayname.md) 4 | 5 | ## FileMetadataResponse.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.error.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [error](./generative-ai.filemetadataresponse.error.md) 4 | 5 | ## FileMetadataResponse.error property 6 | 7 | Error populated if file processing has failed. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | error?: RpcStatus; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md) 4 | 5 | ## FileMetadataResponse.expirationTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | expirationTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [mimeType](./generative-ai.filemetadataresponse.mimetype.md) 4 | 5 | ## FileMetadataResponse.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [name](./generative-ai.filemetadataresponse.name.md) 4 | 5 | ## FileMetadataResponse.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sha256Hash](./generative-ai.filemetadataresponse.sha256hash.md) 4 | 5 | ## FileMetadataResponse.sha256Hash property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | sha256Hash: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sizeBytes](./generative-ai.filemetadataresponse.sizebytes.md) 4 | 5 | ## FileMetadataResponse.sizeBytes property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | sizeBytes: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.state.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [state](./generative-ai.filemetadataresponse.state.md) 4 | 5 | ## FileMetadataResponse.state property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | state: FileState; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.updatetime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [updateTime](./generative-ai.filemetadataresponse.updatetime.md) 4 | 5 | ## FileMetadataResponse.updateTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | updateTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.filemetadataresponse.uri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [uri](./generative-ai.filemetadataresponse.uri.md) 4 | 5 | ## FileMetadataResponse.uri property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | uri: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.googleaifilemanager.apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [apiKey](./generative-ai.googleaifilemanager.apikey.md) 4 | 5 | ## GoogleAIFileManager.apiKey property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | apiKey: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.listfilesresponse.files.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [files](./generative-ai.listfilesresponse.files.md) 4 | 5 | ## ListFilesResponse.files property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | files: FileMetadataResponse[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.listfilesresponse.nextpagetoken.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [nextPageToken](./generative-ai.listfilesresponse.nextpagetoken.md) 4 | 5 | ## ListFilesResponse.nextPageToken property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | nextPageToken?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.listparams.pagesize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageSize](./generative-ai.listparams.pagesize.md) 4 | 5 | ## ListParams.pageSize property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | pageSize?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.listparams.pagetoken.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageToken](./generative-ai.listparams.pagetoken.md) 4 | 5 | ## ListParams.pageToken property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | pageToken?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.requestoptions.apiclient.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [apiClient](./generative-ai.requestoptions.apiclient.md) 4 | 5 | ## RequestOptions.apiClient property 6 | 7 | Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | apiClient?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.requestoptions.baseurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [baseUrl](./generative-ai.requestoptions.baseurl.md) 4 | 5 | ## RequestOptions.baseUrl property 6 | 7 | Base endpoint url. Defaults to "https://generativelanguage.googleapis.com" 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | baseUrl?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.requestoptions.customheaders.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [customHeaders](./generative-ai.requestoptions.customheaders.md) 4 | 5 | ## RequestOptions.customHeaders property 6 | 7 | Custom HTTP request headers. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | customHeaders?: Headers | Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.requestoptions.timeout.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [timeout](./generative-ai.requestoptions.timeout.md) 4 | 5 | ## RequestOptions.timeout property 6 | 7 | Request timeout in milliseconds. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | timeout?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.rpcstatus.code.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [code](./generative-ai.rpcstatus.code.md) 4 | 5 | ## RpcStatus.code property 6 | 7 | Error status code 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | code: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.rpcstatus.details.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [details](./generative-ai.rpcstatus.details.md) 4 | 5 | ## RpcStatus.details property 6 | 7 | A list of messages that carry the error details. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | details?: ErrorDetails[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.rpcstatus.message.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [message](./generative-ai.rpcstatus.message.md) 4 | 5 | ## RpcStatus.message property 6 | 7 | A developer-facing error message. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | message: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/files/generative-ai.uploadfileresponse.file.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UploadFileResponse](./generative-ai.uploadfileresponse.md) > [file](./generative-ai.uploadfileresponse.file.md) 4 | 5 | ## UploadFileResponse.file property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | file: FileMetadataResponse; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/files/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@google/generative-ai](./generative-ai.md) | | 12 | 13 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.arrayschema.items.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [items](./generative-ai.arrayschema.items.md) 4 | 5 | ## ArraySchema.items property 6 | 7 | A schema describing the entries in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | items: Schema; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.arrayschema.maxitems.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [maxItems](./generative-ai.arrayschema.maxitems.md) 4 | 5 | ## ArraySchema.maxItems property 6 | 7 | The maximum number of items in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | maxItems?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.arrayschema.minitems.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [minItems](./generative-ai.arrayschema.minitems.md) 4 | 5 | ## ArraySchema.minItems property 6 | 7 | The minimum number of items in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | minItems?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.arrayschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [type](./generative-ai.arrayschema.type.md) 4 | 5 | ## ArraySchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.ARRAY; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.baseparams.generationconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BaseParams](./generative-ai.baseparams.md) > [generationConfig](./generative-ai.baseparams.generationconfig.md) 4 | 5 | ## BaseParams.generationConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | generationConfig?: GenerationConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.baseparams.safetysettings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BaseParams](./generative-ai.baseparams.md) > [safetySettings](./generative-ai.baseparams.safetysettings.md) 4 | 5 | ## BaseParams.safetySettings property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | safetySettings?: SafetySetting[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.batchembedcontentsrequest.requests.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BatchEmbedContentsRequest](./generative-ai.batchembedcontentsrequest.md) > [requests](./generative-ai.batchembedcontentsrequest.requests.md) 4 | 5 | ## BatchEmbedContentsRequest.requests property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | requests: EmbedContentRequest[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.batchembedcontentsresponse.embeddings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BatchEmbedContentsResponse](./generative-ai.batchembedcontentsresponse.md) > [embeddings](./generative-ai.batchembedcontentsresponse.embeddings.md) 4 | 5 | ## BatchEmbedContentsResponse.embeddings property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | embeddings: ContentEmbedding[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.booleanschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BooleanSchema](./generative-ai.booleanschema.md) > [type](./generative-ai.booleanschema.type.md) 4 | 5 | ## BooleanSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.BOOLEAN; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontent.createtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [createTime](./generative-ai.cachedcontent.createtime.md) 4 | 5 | ## CachedContent.createTime property 6 | 7 | `CachedContent` creation time in ISO string format. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | createTime?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontent.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [name](./generative-ai.cachedcontent.name.md) 4 | 5 | ## CachedContent.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontent.ttl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [ttl](./generative-ai.cachedcontent.ttl.md) 4 | 5 | ## CachedContent.ttl property 6 | 7 | protobuf.Duration format (ex. "3.0001s"). 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | ttl?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontent.updatetime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [updateTime](./generative-ai.cachedcontent.updatetime.md) 4 | 5 | ## CachedContent.updateTime property 6 | 7 | `CachedContent` update time in ISO string format. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | updateTime?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.contents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [contents](./generative-ai.cachedcontentbase.contents.md) 4 | 5 | ## CachedContentBase.contents property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | contents: Content[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [displayName](./generative-ai.cachedcontentbase.displayname.md) 4 | 5 | ## CachedContentBase.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.model.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [model](./generative-ai.cachedcontentbase.model.md) 4 | 5 | ## CachedContentBase.model property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | model?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [systemInstruction](./generative-ai.cachedcontentbase.systeminstruction.md) 4 | 5 | ## CachedContentBase.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: string | Part | Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [toolConfig](./generative-ai.cachedcontentbase.toolconfig.md) 4 | 5 | ## CachedContentBase.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.cachedcontentbase.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [tools](./generative-ai.cachedcontentbase.tools.md) 4 | 5 | ## CachedContentBase.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.chatsession.model.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ChatSession](./generative-ai.chatsession.md) > [model](./generative-ai.chatsession.model.md) 4 | 5 | ## ChatSession.model property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | model: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.chatsession.params.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ChatSession](./generative-ai.chatsession.md) > [params](./generative-ai.chatsession.params.md) 4 | 5 | ## ChatSession.params property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | params?: StartChatParams; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.citationmetadata.citationsources.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CitationMetadata](./generative-ai.citationmetadata.md) > [citationSources](./generative-ai.citationmetadata.citationsources.md) 4 | 5 | ## CitationMetadata.citationSources property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | citationSources: CitationSource[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.citationsource.endindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CitationSource](./generative-ai.citationsource.md) > [endIndex](./generative-ai.citationsource.endindex.md) 4 | 5 | ## CitationSource.endIndex property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | endIndex?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.citationsource.license.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CitationSource](./generative-ai.citationsource.md) > [license](./generative-ai.citationsource.license.md) 4 | 5 | ## CitationSource.license property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | license?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.citationsource.startindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CitationSource](./generative-ai.citationsource.md) > [startIndex](./generative-ai.citationsource.startindex.md) 4 | 5 | ## CitationSource.startIndex property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | startIndex?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.citationsource.uri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CitationSource](./generative-ai.citationsource.md) > [uri](./generative-ai.citationsource.uri.md) 4 | 5 | ## CitationSource.uri property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | uri?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresult.outcome.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResult](./generative-ai.codeexecutionresult.md) > [outcome](./generative-ai.codeexecutionresult.outcome.md) 4 | 5 | ## CodeExecutionResult.outcome property 6 | 7 | Outcome of the code execution. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | outcome: Outcome; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresult.output.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResult](./generative-ai.codeexecutionresult.md) > [output](./generative-ai.codeexecutionresult.output.md) 4 | 5 | ## CodeExecutionResult.output property 6 | 7 | Contains stdout when code execution is successful, stderr or other description otherwise. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | output: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [codeExecutionResult](./generative-ai.codeexecutionresultpart.codeexecutionresult.md) 4 | 5 | ## CodeExecutionResultPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult: CodeExecutionResult; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [executableCode](./generative-ai.codeexecutionresultpart.executablecode.md) 4 | 5 | ## CodeExecutionResultPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [fileData](./generative-ai.codeexecutionresultpart.filedata.md) 4 | 5 | ## CodeExecutionResultPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [functionCall](./generative-ai.codeexecutionresultpart.functioncall.md) 4 | 5 | ## CodeExecutionResultPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [functionResponse](./generative-ai.codeexecutionresultpart.functionresponse.md) 4 | 5 | ## CodeExecutionResultPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [inlineData](./generative-ai.codeexecutionresultpart.inlinedata.md) 4 | 5 | ## CodeExecutionResultPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.codeexecutionresultpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [text](./generative-ai.codeexecutionresultpart.text.md) 4 | 5 | ## CodeExecutionResultPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.content.parts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [Content](./generative-ai.content.md) > [parts](./generative-ai.content.parts.md) 4 | 5 | ## Content.parts property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | parts: Part[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.content.role.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [Content](./generative-ai.content.md) > [role](./generative-ai.content.role.md) 4 | 5 | ## Content.role property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | role: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.contentembedding.values.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ContentEmbedding](./generative-ai.contentembedding.md) > [values](./generative-ai.contentembedding.values.md) 4 | 5 | ## ContentEmbedding.values property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | values: number[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.counttokensrequest.contents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CountTokensRequest](./generative-ai.counttokensrequest.md) > [contents](./generative-ai.counttokensrequest.contents.md) 4 | 5 | ## CountTokensRequest.contents property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | contents?: Content[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.counttokensrequest.generatecontentrequest.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CountTokensRequest](./generative-ai.counttokensrequest.md) > [generateContentRequest](./generative-ai.counttokensrequest.generatecontentrequest.md) 4 | 5 | ## CountTokensRequest.generateContentRequest property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | generateContentRequest?: GenerateContentRequest; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.counttokensresponse.totaltokens.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CountTokensResponse](./generative-ai.counttokensresponse.md) > [totalTokens](./generative-ai.counttokensresponse.totaltokens.md) 4 | 5 | ## CountTokensResponse.totalTokens property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | totalTokens: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.dynamicretrievalconfig.mode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [DynamicRetrievalConfig](./generative-ai.dynamicretrievalconfig.md) > [mode](./generative-ai.dynamicretrievalconfig.mode.md) 4 | 5 | ## DynamicRetrievalConfig.mode property 6 | 7 | The mode of the predictor to be used in dynamic retrieval. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | mode?: DynamicRetrievalMode; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.embedcontentrequest.content.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [EmbedContentRequest](./generative-ai.embedcontentrequest.md) > [content](./generative-ai.embedcontentrequest.content.md) 4 | 5 | ## EmbedContentRequest.content property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | content: Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.embedcontentrequest.tasktype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [EmbedContentRequest](./generative-ai.embedcontentrequest.md) > [taskType](./generative-ai.embedcontentrequest.tasktype.md) 4 | 5 | ## EmbedContentRequest.taskType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | taskType?: TaskType; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.embedcontentrequest.title.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [EmbedContentRequest](./generative-ai.embedcontentrequest.md) > [title](./generative-ai.embedcontentrequest.title.md) 4 | 5 | ## EmbedContentRequest.title property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | title?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.embedcontentresponse.embedding.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [EmbedContentResponse](./generative-ai.embedcontentresponse.md) > [embedding](./generative-ai.embedcontentresponse.embedding.md) 4 | 5 | ## EmbedContentResponse.embedding property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | embedding: ContentEmbedding; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.errordetails.__type_.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > ["@type"](./generative-ai.errordetails.__type_.md) 4 | 5 | ## ErrorDetails."@type" property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | "@type"?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.errordetails.domain.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [domain](./generative-ai.errordetails.domain.md) 4 | 5 | ## ErrorDetails.domain property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | domain?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.errordetails.metadata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [metadata](./generative-ai.errordetails.metadata.md) 4 | 5 | ## ErrorDetails.metadata property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | metadata?: Record; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.errordetails.reason.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [reason](./generative-ai.errordetails.reason.md) 4 | 5 | ## ErrorDetails.reason property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | reason?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecode.code.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCode](./generative-ai.executablecode.md) > [code](./generative-ai.executablecode.code.md) 4 | 5 | ## ExecutableCode.code property 6 | 7 | The code to be executed. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | code: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecode.language.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCode](./generative-ai.executablecode.md) > [language](./generative-ai.executablecode.language.md) 4 | 5 | ## ExecutableCode.language property 6 | 7 | Programming language of the `code`. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | language: ExecutableCodeLanguage; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [codeExecutionResult](./generative-ai.executablecodepart.codeexecutionresult.md) 4 | 5 | ## ExecutableCodePart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [executableCode](./generative-ai.executablecodepart.executablecode.md) 4 | 5 | ## ExecutableCodePart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode: ExecutableCode; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [fileData](./generative-ai.executablecodepart.filedata.md) 4 | 5 | ## ExecutableCodePart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [functionCall](./generative-ai.executablecodepart.functioncall.md) 4 | 5 | ## ExecutableCodePart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [functionResponse](./generative-ai.executablecodepart.functionresponse.md) 4 | 5 | ## ExecutableCodePart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [inlineData](./generative-ai.executablecodepart.inlinedata.md) 4 | 5 | ## ExecutableCodePart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.executablecodepart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [text](./generative-ai.executablecodepart.text.md) 4 | 5 | ## ExecutableCodePart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedata.fileuri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [fileUri](./generative-ai.filedata.fileuri.md) 4 | 5 | ## FileData.fileUri property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileUri: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedata.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [mimeType](./generative-ai.filedata.mimetype.md) 4 | 5 | ## FileData.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [codeExecutionResult](./generative-ai.filedatapart.codeexecutionresult.md) 4 | 5 | ## FileDataPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [executableCode](./generative-ai.filedatapart.executablecode.md) 4 | 5 | ## FileDataPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [fileData](./generative-ai.filedatapart.filedata.md) 4 | 5 | ## FileDataPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData: FileData; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionCall](./generative-ai.filedatapart.functioncall.md) 4 | 5 | ## FileDataPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionResponse](./generative-ai.filedatapart.functionresponse.md) 4 | 5 | ## FileDataPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [inlineData](./generative-ai.filedatapart.inlinedata.md) 4 | 5 | ## FileDataPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.filedatapart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [text](./generative-ai.filedatapart.text.md) 4 | 5 | ## FileDataPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncall.args.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCall](./generative-ai.functioncall.md) > [args](./generative-ai.functioncall.args.md) 4 | 5 | ## FunctionCall.args property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | args: object; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncall.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCall](./generative-ai.functioncall.md) > [name](./generative-ai.functioncall.name.md) 4 | 5 | ## FunctionCall.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallingconfig.allowedfunctionnames.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [allowedFunctionNames](./generative-ai.functioncallingconfig.allowedfunctionnames.md) 4 | 5 | ## FunctionCallingConfig.allowedFunctionNames property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | allowedFunctionNames?: string[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallingconfig.mode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [mode](./generative-ai.functioncallingconfig.mode.md) 4 | 5 | ## FunctionCallingConfig.mode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mode?: FunctionCallingMode; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [codeExecutionResult](./generative-ai.functioncallpart.codeexecutionresult.md) 4 | 5 | ## FunctionCallPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [executableCode](./generative-ai.functioncallpart.executablecode.md) 4 | 5 | ## FunctionCallPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [fileData](./generative-ai.functioncallpart.filedata.md) 4 | 5 | ## FunctionCallPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [functionCall](./generative-ai.functioncallpart.functioncall.md) 4 | 5 | ## FunctionCallPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall: FunctionCall; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [functionResponse](./generative-ai.functioncallpart.functionresponse.md) 4 | 5 | ## FunctionCallPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [inlineData](./generative-ai.functioncallpart.inlinedata.md) 4 | 5 | ## FunctionCallPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functioncallpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [text](./generative-ai.functioncallpart.text.md) 4 | 5 | ## FunctionCallPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functiondeclarationschema.description.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md) > [description](./generative-ai.functiondeclarationschema.description.md) 4 | 5 | ## FunctionDeclarationSchema.description property 6 | 7 | Optional. Description of the parameter. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | description?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functiondeclarationschema.required.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md) > [required](./generative-ai.functiondeclarationschema.required.md) 4 | 5 | ## FunctionDeclarationSchema.required property 6 | 7 | Optional. Array of required parameters. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | required?: string[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functiondeclarationschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md) > [type](./generative-ai.functiondeclarationschema.type.md) 4 | 5 | ## FunctionDeclarationSchema.type property 6 | 7 | The type of the parameter. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | type: SchemaType; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponse.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponse](./generative-ai.functionresponse.md) > [name](./generative-ai.functionresponse.name.md) 4 | 5 | ## FunctionResponse.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponse.response.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponse](./generative-ai.functionresponse.md) > [response](./generative-ai.functionresponse.response.md) 4 | 5 | ## FunctionResponse.response property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | response: object; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [codeExecutionResult](./generative-ai.functionresponsepart.codeexecutionresult.md) 4 | 5 | ## FunctionResponsePart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [executableCode](./generative-ai.functionresponsepart.executablecode.md) 4 | 5 | ## FunctionResponsePart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [fileData](./generative-ai.functionresponsepart.filedata.md) 4 | 5 | ## FunctionResponsePart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [functionCall](./generative-ai.functionresponsepart.functioncall.md) 4 | 5 | ## FunctionResponsePart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [functionResponse](./generative-ai.functionresponsepart.functionresponse.md) 4 | 5 | ## FunctionResponsePart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse: FunctionResponse; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [inlineData](./generative-ai.functionresponsepart.inlinedata.md) 4 | 5 | ## FunctionResponsePart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.functionresponsepart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [text](./generative-ai.functionresponsepart.text.md) 4 | 5 | ## FunctionResponsePart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.citationmetadata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [citationMetadata](./generative-ai.generatecontentcandidate.citationmetadata.md) 4 | 5 | ## GenerateContentCandidate.citationMetadata property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | citationMetadata?: CitationMetadata; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.content.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [content](./generative-ai.generatecontentcandidate.content.md) 4 | 5 | ## GenerateContentCandidate.content property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | content: Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.finishmessage.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [finishMessage](./generative-ai.generatecontentcandidate.finishmessage.md) 4 | 5 | ## GenerateContentCandidate.finishMessage property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | finishMessage?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.finishreason.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [finishReason](./generative-ai.generatecontentcandidate.finishreason.md) 4 | 5 | ## GenerateContentCandidate.finishReason property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | finishReason?: FinishReason; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [index](./generative-ai.generatecontentcandidate.index.md) 4 | 5 | ## GenerateContentCandidate.index property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | index: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentcandidate.safetyratings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) > [safetyRatings](./generative-ai.generatecontentcandidate.safetyratings.md) 4 | 5 | ## GenerateContentCandidate.safetyRatings property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | safetyRatings?: SafetyRating[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentrequest.contents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [contents](./generative-ai.generatecontentrequest.contents.md) 4 | 5 | ## GenerateContentRequest.contents property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | contents: Content[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentrequest.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [systemInstruction](./generative-ai.generatecontentrequest.systeminstruction.md) 4 | 5 | ## GenerateContentRequest.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: string | Part | Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentrequest.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [toolConfig](./generative-ai.generatecontentrequest.toolconfig.md) 4 | 5 | ## GenerateContentRequest.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentrequest.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [tools](./generative-ai.generatecontentrequest.tools.md) 4 | 5 | ## GenerateContentRequest.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentresult.response.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentResult](./generative-ai.generatecontentresult.md) > [response](./generative-ai.generatecontentresult.response.md) 4 | 5 | ## GenerateContentResult.response property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | response: EnhancedGenerateContentResponse; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentstreamresult.response.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentStreamResult](./generative-ai.generatecontentstreamresult.md) > [response](./generative-ai.generatecontentstreamresult.response.md) 4 | 5 | ## GenerateContentStreamResult.response property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | response: Promise; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generatecontentstreamresult.stream.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentStreamResult](./generative-ai.generatecontentstreamresult.md) > [stream](./generative-ai.generatecontentstreamresult.stream.md) 4 | 5 | ## GenerateContentStreamResult.stream property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | stream: AsyncGenerator; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.candidatecount.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [candidateCount](./generative-ai.generationconfig.candidatecount.md) 4 | 5 | ## GenerationConfig.candidateCount property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | candidateCount?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.maxoutputtokens.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [maxOutputTokens](./generative-ai.generationconfig.maxoutputtokens.md) 4 | 5 | ## GenerationConfig.maxOutputTokens property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | maxOutputTokens?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.responselogprobs.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [responseLogprobs](./generative-ai.generationconfig.responselogprobs.md) 4 | 5 | ## GenerationConfig.responseLogprobs property 6 | 7 | If True, export the logprobs results in response. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | responseLogprobs?: boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.stopsequences.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [stopSequences](./generative-ai.generationconfig.stopsequences.md) 4 | 5 | ## GenerationConfig.stopSequences property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | stopSequences?: string[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.temperature.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [temperature](./generative-ai.generationconfig.temperature.md) 4 | 5 | ## GenerationConfig.temperature property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | temperature?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.topk.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [topK](./generative-ai.generationconfig.topk.md) 4 | 5 | ## GenerationConfig.topK property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | topK?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generationconfig.topp.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [topP](./generative-ai.generationconfig.topp.md) 4 | 5 | ## GenerationConfig.topP property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | topP?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativecontentblob.data.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeContentBlob](./generative-ai.generativecontentblob.md) > [data](./generative-ai.generativecontentblob.data.md) 4 | 5 | ## GenerativeContentBlob.data property 6 | 7 | Image as a base64 string. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | data: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativecontentblob.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeContentBlob](./generative-ai.generativecontentblob.md) > [mimeType](./generative-ai.generativecontentblob.mimetype.md) 4 | 5 | ## GenerativeContentBlob.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [apiKey](./generative-ai.generativemodel.apikey.md) 4 | 5 | ## GenerativeModel.apiKey property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | apiKey: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.cachedcontent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [cachedContent](./generative-ai.generativemodel.cachedcontent.md) 4 | 5 | ## GenerativeModel.cachedContent property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | cachedContent: CachedContent; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.generationconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [generationConfig](./generative-ai.generativemodel.generationconfig.md) 4 | 5 | ## GenerativeModel.generationConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | generationConfig: GenerationConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.model.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [model](./generative-ai.generativemodel.model.md) 4 | 5 | ## GenerativeModel.model property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | model: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.safetysettings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [safetySettings](./generative-ai.generativemodel.safetysettings.md) 4 | 5 | ## GenerativeModel.safetySettings property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | safetySettings: SafetySetting[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [systemInstruction](./generative-ai.generativemodel.systeminstruction.md) 4 | 5 | ## GenerativeModel.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [toolConfig](./generative-ai.generativemodel.toolconfig.md) 4 | 5 | ## GenerativeModel.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.generativemodel.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [tools](./generative-ai.generativemodel.tools.md) 4 | 5 | ## GenerativeModel.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.googlegenerativeai.apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAI](./generative-ai.googlegenerativeai.md) > [apiKey](./generative-ai.googlegenerativeai.apikey.md) 4 | 5 | ## GoogleGenerativeAI.apiKey property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | apiKey: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.googlegenerativeaifetcherror.errordetails.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAIFetchError](./generative-ai.googlegenerativeaifetcherror.md) > [errorDetails](./generative-ai.googlegenerativeaifetcherror.errordetails.md) 4 | 5 | ## GoogleGenerativeAIFetchError.errorDetails property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | errorDetails?: ErrorDetails[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.googlegenerativeaifetcherror.status.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAIFetchError](./generative-ai.googlegenerativeaifetcherror.md) > [status](./generative-ai.googlegenerativeaifetcherror.status.md) 4 | 5 | ## GoogleGenerativeAIFetchError.status property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | status?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.googlegenerativeaifetcherror.statustext.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAIFetchError](./generative-ai.googlegenerativeaifetcherror.md) > [statusText](./generative-ai.googlegenerativeaifetcherror.statustext.md) 4 | 5 | ## GoogleGenerativeAIFetchError.statusText property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | statusText?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.googlegenerativeairesponseerror.response.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAIResponseError](./generative-ai.googlegenerativeairesponseerror.md) > [response](./generative-ai.googlegenerativeairesponseerror.response.md) 4 | 5 | ## GoogleGenerativeAIResponseError.response property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | response?: T; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingchunk.web.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingChunk](./generative-ai.groundingchunk.md) > [web](./generative-ai.groundingchunk.web.md) 4 | 5 | ## GroundingChunk.web property 6 | 7 | Chunk from the web. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | web?: GroundingChunkWeb; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingchunkweb.title.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingChunkWeb](./generative-ai.groundingchunkweb.md) > [title](./generative-ai.groundingchunkweb.title.md) 4 | 5 | ## GroundingChunkWeb.title property 6 | 7 | Title of the chunk. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | title?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingchunkweb.uri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingChunkWeb](./generative-ai.groundingchunkweb.md) > [uri](./generative-ai.groundingchunkweb.uri.md) 4 | 5 | ## GroundingChunkWeb.uri property 6 | 7 | URI reference of the chunk. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | uri?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingmetadata.groundingsupports.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingMetadata](./generative-ai.groundingmetadata.md) > [groundingSupports](./generative-ai.groundingmetadata.groundingsupports.md) 4 | 5 | ## GroundingMetadata.groundingSupports property 6 | 7 | List of grounding support. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | groundingSupports?: GroundingSupport[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingsupport.segment.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingSupport](./generative-ai.groundingsupport.md) > [segment](./generative-ai.groundingsupport.segment.md) 4 | 5 | ## GroundingSupport.segment property 6 | 7 | URI reference of the chunk. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | segment?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.groundingsupportsegment.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GroundingSupportSegment](./generative-ai.groundingsupportsegment.md) > [text](./generative-ai.groundingsupportsegment.text.md) 4 | 5 | ## GroundingSupportSegment.text property 6 | 7 | The text corresponding to the segment from the response. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | text?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [codeExecutionResult](./generative-ai.inlinedatapart.codeexecutionresult.md) 4 | 5 | ## InlineDataPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [executableCode](./generative-ai.inlinedatapart.executablecode.md) 4 | 5 | ## InlineDataPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [fileData](./generative-ai.inlinedatapart.filedata.md) 4 | 5 | ## InlineDataPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [functionCall](./generative-ai.inlinedatapart.functioncall.md) 4 | 5 | ## InlineDataPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [functionResponse](./generative-ai.inlinedatapart.functionresponse.md) 4 | 5 | ## InlineDataPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [inlineData](./generative-ai.inlinedatapart.inlinedata.md) 4 | 5 | ## InlineDataPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData: GenerativeContentBlob; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.inlinedatapart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [text](./generative-ai.inlinedatapart.text.md) 4 | 5 | ## InlineDataPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.integerschema.format.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [IntegerSchema](./generative-ai.integerschema.md) > [format](./generative-ai.integerschema.format.md) 4 | 5 | ## IntegerSchema.format property 6 | 7 | Optional. The format of the number. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | format?: "int32" | "int64"; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.integerschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [IntegerSchema](./generative-ai.integerschema.md) > [type](./generative-ai.integerschema.type.md) 4 | 5 | ## IntegerSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.INTEGER; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.logprobscandidate.logprobability.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [LogprobsCandidate](./generative-ai.logprobscandidate.md) > [logProbability](./generative-ai.logprobscandidate.logprobability.md) 4 | 5 | ## LogprobsCandidate.logProbability property 6 | 7 | The candidate's log probability. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | logProbability: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.logprobscandidate.token.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [LogprobsCandidate](./generative-ai.logprobscandidate.md) > [token](./generative-ai.logprobscandidate.token.md) 4 | 5 | ## LogprobsCandidate.token property 6 | 7 | The candidate's token string value. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | token: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.logprobscandidate.tokenid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [LogprobsCandidate](./generative-ai.logprobscandidate.md) > [tokenID](./generative-ai.logprobscandidate.tokenid.md) 4 | 5 | ## LogprobsCandidate.tokenID property 6 | 7 | The candidate's token id value. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | tokenID: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.logprobsresult.topcandidates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [LogprobsResult](./generative-ai.logprobsresult.md) > [topCandidates](./generative-ai.logprobsresult.topcandidates.md) 4 | 5 | ## LogprobsResult.topCandidates property 6 | 7 | Length = total number of decoding steps. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | topCandidates: TopCandidates[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.modelparams.cachedcontent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [cachedContent](./generative-ai.modelparams.cachedcontent.md) 4 | 5 | ## ModelParams.cachedContent property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | cachedContent?: CachedContent; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.modelparams.model.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [model](./generative-ai.modelparams.model.md) 4 | 5 | ## ModelParams.model property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | model: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.modelparams.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [systemInstruction](./generative-ai.modelparams.systeminstruction.md) 4 | 5 | ## ModelParams.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: string | Part | Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.modelparams.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [toolConfig](./generative-ai.modelparams.toolconfig.md) 4 | 5 | ## ModelParams.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.modelparams.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [tools](./generative-ai.modelparams.tools.md) 4 | 5 | ## ModelParams.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.numberschema.format.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [NumberSchema](./generative-ai.numberschema.md) > [format](./generative-ai.numberschema.format.md) 4 | 5 | ## NumberSchema.format property 6 | 7 | Optional. The format of the number. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | format?: "float" | "double"; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.numberschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [NumberSchema](./generative-ai.numberschema.md) > [type](./generative-ai.numberschema.type.md) 4 | 5 | ## NumberSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.NUMBER; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.objectschema.properties.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ObjectSchema](./generative-ai.objectschema.md) > [properties](./generative-ai.objectschema.properties.md) 4 | 5 | ## ObjectSchema.properties property 6 | 7 | Describes the properties of the JSON object. Must not be empty. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | properties: { 13 | [k: string]: Schema; 14 | }; 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.objectschema.required.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ObjectSchema](./generative-ai.objectschema.md) > [required](./generative-ai.objectschema.required.md) 4 | 5 | ## ObjectSchema.required property 6 | 7 | A list of keys declared in the properties object. Required properties will always be present in the generated object. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | required?: string[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.objectschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ObjectSchema](./generative-ai.objectschema.md) > [type](./generative-ai.objectschema.type.md) 4 | 5 | ## ObjectSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.OBJECT; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.possible_roles.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [POSSIBLE\_ROLES](./generative-ai.possible_roles.md) 4 | 5 | ## POSSIBLE\_ROLES variable 6 | 7 | Possible roles. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | POSSIBLE_ROLES: readonly ["user", "model", "function", "system"] 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.promptfeedback.blockreason.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [PromptFeedback](./generative-ai.promptfeedback.md) > [blockReason](./generative-ai.promptfeedback.blockreason.md) 4 | 5 | ## PromptFeedback.blockReason property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | blockReason: BlockReason; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.promptfeedback.blockreasonmessage.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [PromptFeedback](./generative-ai.promptfeedback.md) > [blockReasonMessage](./generative-ai.promptfeedback.blockreasonmessage.md) 4 | 5 | ## PromptFeedback.blockReasonMessage property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | blockReasonMessage?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.promptfeedback.safetyratings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [PromptFeedback](./generative-ai.promptfeedback.md) > [safetyRatings](./generative-ai.promptfeedback.safetyratings.md) 4 | 5 | ## PromptFeedback.safetyRatings property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | safetyRatings: SafetyRating[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.requestoptions.apiclient.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [apiClient](./generative-ai.requestoptions.apiclient.md) 4 | 5 | ## RequestOptions.apiClient property 6 | 7 | Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | apiClient?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.requestoptions.baseurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [baseUrl](./generative-ai.requestoptions.baseurl.md) 4 | 5 | ## RequestOptions.baseUrl property 6 | 7 | Base endpoint url. Defaults to "https://generativelanguage.googleapis.com" 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | baseUrl?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.requestoptions.customheaders.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [customHeaders](./generative-ai.requestoptions.customheaders.md) 4 | 5 | ## RequestOptions.customHeaders property 6 | 7 | Custom HTTP request headers. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | customHeaders?: Headers | Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.requestoptions.timeout.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [timeout](./generative-ai.requestoptions.timeout.md) 4 | 5 | ## RequestOptions.timeout property 6 | 7 | Request timeout in milliseconds. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | timeout?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.responseschema.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ResponseSchema](./generative-ai.responseschema.md) 4 | 5 | ## ResponseSchema type 6 | 7 | Schema passed to `GenerationConfig.responseSchema` 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | export type ResponseSchema = Schema; 13 | ``` 14 | **References:** [Schema](./generative-ai.schema.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.safetyrating.category.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [SafetyRating](./generative-ai.safetyrating.md) > [category](./generative-ai.safetyrating.category.md) 4 | 5 | ## SafetyRating.category property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | category: HarmCategory; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.safetyrating.probability.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [SafetyRating](./generative-ai.safetyrating.md) > [probability](./generative-ai.safetyrating.probability.md) 4 | 5 | ## SafetyRating.probability property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | probability: HarmProbability; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.safetysetting.category.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [SafetySetting](./generative-ai.safetysetting.md) > [category](./generative-ai.safetysetting.category.md) 4 | 5 | ## SafetySetting.category property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | category: HarmCategory; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.safetysetting.threshold.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [SafetySetting](./generative-ai.safetysetting.md) > [threshold](./generative-ai.safetysetting.threshold.md) 4 | 5 | ## SafetySetting.threshold property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | threshold: HarmBlockThreshold; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.searchentrypoint.sdkblob.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [SearchEntryPoint](./generative-ai.searchentrypoint.md) > [sdkBlob](./generative-ai.searchentrypoint.sdkblob.md) 4 | 5 | ## SearchEntryPoint.sdkBlob property 6 | 7 | Base64 encoded JSON representing array of <search term, search url> tuple. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | sdkBlob?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.startchatparams.cachedcontent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [cachedContent](./generative-ai.startchatparams.cachedcontent.md) 4 | 5 | ## StartChatParams.cachedContent property 6 | 7 | This is the name of a `CachedContent` and not the cache object itself. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | cachedContent?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.startchatparams.history.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [history](./generative-ai.startchatparams.history.md) 4 | 5 | ## StartChatParams.history property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | history?: Content[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.startchatparams.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [systemInstruction](./generative-ai.startchatparams.systeminstruction.md) 4 | 5 | ## StartChatParams.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: string | Part | Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.startchatparams.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [toolConfig](./generative-ai.startchatparams.toolconfig.md) 4 | 5 | ## StartChatParams.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.startchatparams.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [tools](./generative-ai.startchatparams.tools.md) 4 | 5 | ## StartChatParams.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.stringschema.enum.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StringSchema](./generative-ai.stringschema.md) > [enum](./generative-ai.stringschema.enum.md) 4 | 5 | ## StringSchema.enum property 6 | 7 | If present, limits the result to one of the given values. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | enum?: string[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.stringschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StringSchema](./generative-ai.stringschema.md) > [type](./generative-ai.stringschema.type.md) 4 | 5 | ## StringSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.STRING; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [codeExecutionResult](./generative-ai.textpart.codeexecutionresult.md) 4 | 5 | ## TextPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [executableCode](./generative-ai.textpart.executablecode.md) 4 | 5 | ## TextPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [fileData](./generative-ai.textpart.filedata.md) 4 | 5 | ## TextPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [functionCall](./generative-ai.textpart.functioncall.md) 4 | 5 | ## TextPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [functionResponse](./generative-ai.textpart.functionresponse.md) 4 | 5 | ## TextPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [inlineData](./generative-ai.textpart.inlinedata.md) 4 | 5 | ## TextPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.textpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [text](./generative-ai.textpart.text.md) 4 | 5 | ## TextPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.toolconfig.functioncallingconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ToolConfig](./generative-ai.toolconfig.md) > [functionCallingConfig](./generative-ai.toolconfig.functioncallingconfig.md) 4 | 5 | ## ToolConfig.functionCallingConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCallingConfig: FunctionCallingConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.topcandidates.candidates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TopCandidates](./generative-ai.topcandidates.md) > [candidates](./generative-ai.topcandidates.candidates.md) 4 | 5 | ## TopCandidates.candidates property 6 | 7 | Sorted by log probability in descending order. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | candidates: LogprobsCandidate[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.usagemetadata.prompttokencount.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UsageMetadata](./generative-ai.usagemetadata.md) > [promptTokenCount](./generative-ai.usagemetadata.prompttokencount.md) 4 | 5 | ## UsageMetadata.promptTokenCount property 6 | 7 | Number of tokens in the prompt. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | promptTokenCount: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/generative-ai.usagemetadata.totaltokencount.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UsageMetadata](./generative-ai.usagemetadata.md) > [totalTokenCount](./generative-ai.usagemetadata.totaltokencount.md) 4 | 5 | ## UsageMetadata.totalTokenCount property 6 | 7 | Total token count for the generation request (prompt + candidates). 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | totalTokenCount: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/main/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@google/generative-ai](./generative-ai.md) | | 12 | 13 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.arrayschema.items.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [items](./generative-ai.arrayschema.items.md) 4 | 5 | ## ArraySchema.items property 6 | 7 | A schema describing the entries in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | items: Schema; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.arrayschema.maxitems.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [maxItems](./generative-ai.arrayschema.maxitems.md) 4 | 5 | ## ArraySchema.maxItems property 6 | 7 | The maximum number of items in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | maxItems?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.arrayschema.minitems.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [minItems](./generative-ai.arrayschema.minitems.md) 4 | 5 | ## ArraySchema.minItems property 6 | 7 | The minimum number of items in the array. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | minItems?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.arrayschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ArraySchema](./generative-ai.arrayschema.md) > [type](./generative-ai.arrayschema.type.md) 4 | 5 | ## ArraySchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.ARRAY; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.booleanschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [BooleanSchema](./generative-ai.booleanschema.md) > [type](./generative-ai.booleanschema.type.md) 4 | 5 | ## BooleanSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.BOOLEAN; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontent.createtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [createTime](./generative-ai.cachedcontent.createtime.md) 4 | 5 | ## CachedContent.createTime property 6 | 7 | `CachedContent` creation time in ISO string format. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | createTime?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontent.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [name](./generative-ai.cachedcontent.name.md) 4 | 5 | ## CachedContent.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontent.ttl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [ttl](./generative-ai.cachedcontent.ttl.md) 4 | 5 | ## CachedContent.ttl property 6 | 7 | protobuf.Duration format (ex. "3.0001s"). 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | ttl?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontent.updatetime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContent](./generative-ai.cachedcontent.md) > [updateTime](./generative-ai.cachedcontent.updatetime.md) 4 | 5 | ## CachedContent.updateTime property 6 | 7 | `CachedContent` update time in ISO string format. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | updateTime?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.contents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [contents](./generative-ai.cachedcontentbase.contents.md) 4 | 5 | ## CachedContentBase.contents property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | contents: Content[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [displayName](./generative-ai.cachedcontentbase.displayname.md) 4 | 5 | ## CachedContentBase.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.model.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [model](./generative-ai.cachedcontentbase.model.md) 4 | 5 | ## CachedContentBase.model property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | model?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.systeminstruction.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [systemInstruction](./generative-ai.cachedcontentbase.systeminstruction.md) 4 | 5 | ## CachedContentBase.systemInstruction property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | systemInstruction?: string | Part | Content; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.toolconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [toolConfig](./generative-ai.cachedcontentbase.toolconfig.md) 4 | 5 | ## CachedContentBase.toolConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | toolConfig?: ToolConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentbase.tools.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentBase](./generative-ai.cachedcontentbase.md) > [tools](./generative-ai.cachedcontentbase.tools.md) 4 | 5 | ## CachedContentBase.tools property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | tools?: Tool[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentupdateinputfields.expiretime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentUpdateInputFields](./generative-ai.cachedcontentupdateinputfields.md) > [expireTime](./generative-ai.cachedcontentupdateinputfields.expiretime.md) 4 | 5 | ## CachedContentUpdateInputFields.expireTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | expireTime?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentupdateinputfields.ttlseconds.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentUpdateInputFields](./generative-ai.cachedcontentupdateinputfields.md) > [ttlSeconds](./generative-ai.cachedcontentupdateinputfields.ttlseconds.md) 4 | 5 | ## CachedContentUpdateInputFields.ttlSeconds property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | ttlSeconds?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.cachedcontentupdateparams.cachedcontent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CachedContentUpdateParams](./generative-ai.cachedcontentupdateparams.md) > [cachedContent](./generative-ai.cachedcontentupdateparams.cachedcontent.md) 4 | 5 | ## CachedContentUpdateParams.cachedContent property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | cachedContent: CachedContentUpdateInputFields; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresult.outcome.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResult](./generative-ai.codeexecutionresult.md) > [outcome](./generative-ai.codeexecutionresult.outcome.md) 4 | 5 | ## CodeExecutionResult.outcome property 6 | 7 | Outcome of the code execution. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | outcome: Outcome; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [codeExecutionResult](./generative-ai.codeexecutionresultpart.codeexecutionresult.md) 4 | 5 | ## CodeExecutionResultPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult: CodeExecutionResult; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [executableCode](./generative-ai.codeexecutionresultpart.executablecode.md) 4 | 5 | ## CodeExecutionResultPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [fileData](./generative-ai.codeexecutionresultpart.filedata.md) 4 | 5 | ## CodeExecutionResultPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [functionCall](./generative-ai.codeexecutionresultpart.functioncall.md) 4 | 5 | ## CodeExecutionResultPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [functionResponse](./generative-ai.codeexecutionresultpart.functionresponse.md) 4 | 5 | ## CodeExecutionResultPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [inlineData](./generative-ai.codeexecutionresultpart.inlinedata.md) 4 | 5 | ## CodeExecutionResultPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.codeexecutionresultpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [CodeExecutionResultPart](./generative-ai.codeexecutionresultpart.md) > [text](./generative-ai.codeexecutionresultpart.text.md) 4 | 5 | ## CodeExecutionResultPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.content.parts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [Content](./generative-ai.content.md) > [parts](./generative-ai.content.parts.md) 4 | 5 | ## Content.parts property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | parts: Part[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.content.role.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [Content](./generative-ai.content.md) > [role](./generative-ai.content.role.md) 4 | 5 | ## Content.role property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | role: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.errordetails.__type_.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > ["@type"](./generative-ai.errordetails.__type_.md) 4 | 5 | ## ErrorDetails."@type" property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | "@type"?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.errordetails.domain.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [domain](./generative-ai.errordetails.domain.md) 4 | 5 | ## ErrorDetails.domain property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | domain?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.errordetails.metadata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [metadata](./generative-ai.errordetails.metadata.md) 4 | 5 | ## ErrorDetails.metadata property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | metadata?: Record; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.errordetails.reason.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetails](./generative-ai.errordetails.md) > [reason](./generative-ai.errordetails.reason.md) 4 | 5 | ## ErrorDetails.reason property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | reason?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecode.code.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCode](./generative-ai.executablecode.md) > [code](./generative-ai.executablecode.code.md) 4 | 5 | ## ExecutableCode.code property 6 | 7 | The code to be executed. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | code: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecode.language.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCode](./generative-ai.executablecode.md) > [language](./generative-ai.executablecode.language.md) 4 | 5 | ## ExecutableCode.language property 6 | 7 | Programming language of the `code`. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | language: ExecutableCodeLanguage; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [codeExecutionResult](./generative-ai.executablecodepart.codeexecutionresult.md) 4 | 5 | ## ExecutableCodePart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [executableCode](./generative-ai.executablecodepart.executablecode.md) 4 | 5 | ## ExecutableCodePart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode: ExecutableCode; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [fileData](./generative-ai.executablecodepart.filedata.md) 4 | 5 | ## ExecutableCodePart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [functionCall](./generative-ai.executablecodepart.functioncall.md) 4 | 5 | ## ExecutableCodePart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [functionResponse](./generative-ai.executablecodepart.functionresponse.md) 4 | 5 | ## ExecutableCodePart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [inlineData](./generative-ai.executablecodepart.inlinedata.md) 4 | 5 | ## ExecutableCodePart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.executablecodepart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ExecutableCodePart](./generative-ai.executablecodepart.md) > [text](./generative-ai.executablecodepart.text.md) 4 | 5 | ## ExecutableCodePart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedata.fileuri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [fileUri](./generative-ai.filedata.fileuri.md) 4 | 5 | ## FileData.fileUri property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileUri: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedata.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [mimeType](./generative-ai.filedata.mimetype.md) 4 | 5 | ## FileData.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [codeExecutionResult](./generative-ai.filedatapart.codeexecutionresult.md) 4 | 5 | ## FileDataPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [executableCode](./generative-ai.filedatapart.executablecode.md) 4 | 5 | ## FileDataPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [fileData](./generative-ai.filedatapart.filedata.md) 4 | 5 | ## FileDataPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData: FileData; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionCall](./generative-ai.filedatapart.functioncall.md) 4 | 5 | ## FileDataPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionResponse](./generative-ai.filedatapart.functionresponse.md) 4 | 5 | ## FileDataPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [inlineData](./generative-ai.filedatapart.inlinedata.md) 4 | 5 | ## FileDataPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filedatapart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [text](./generative-ai.filedatapart.text.md) 4 | 5 | ## FileDataPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadata.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [displayName](./generative-ai.filemetadata.displayname.md) 4 | 5 | ## FileMetadata.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadata.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [mimeType](./generative-ai.filemetadata.mimetype.md) 4 | 5 | ## FileMetadata.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadata.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [name](./generative-ai.filemetadata.name.md) 4 | 5 | ## FileMetadata.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.createtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [createTime](./generative-ai.filemetadataresponse.createtime.md) 4 | 5 | ## FileMetadataResponse.createTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | createTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.displayname.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [displayName](./generative-ai.filemetadataresponse.displayname.md) 4 | 5 | ## FileMetadataResponse.displayName property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | displayName?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.error.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [error](./generative-ai.filemetadataresponse.error.md) 4 | 5 | ## FileMetadataResponse.error property 6 | 7 | Error populated if file processing has failed. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | error?: RpcStatus; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.expirationtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md) 4 | 5 | ## FileMetadataResponse.expirationTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | expirationTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [mimeType](./generative-ai.filemetadataresponse.mimetype.md) 4 | 5 | ## FileMetadataResponse.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [name](./generative-ai.filemetadataresponse.name.md) 4 | 5 | ## FileMetadataResponse.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.sha256hash.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sha256Hash](./generative-ai.filemetadataresponse.sha256hash.md) 4 | 5 | ## FileMetadataResponse.sha256Hash property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | sha256Hash: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.sizebytes.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sizeBytes](./generative-ai.filemetadataresponse.sizebytes.md) 4 | 5 | ## FileMetadataResponse.sizeBytes property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | sizeBytes: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.state.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [state](./generative-ai.filemetadataresponse.state.md) 4 | 5 | ## FileMetadataResponse.state property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | state: FileState; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.updatetime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [updateTime](./generative-ai.filemetadataresponse.updatetime.md) 4 | 5 | ## FileMetadataResponse.updateTime property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | updateTime: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.filemetadataresponse.uri.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [uri](./generative-ai.filemetadataresponse.uri.md) 4 | 5 | ## FileMetadataResponse.uri property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | uri: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncall.args.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCall](./generative-ai.functioncall.md) > [args](./generative-ai.functioncall.args.md) 4 | 5 | ## FunctionCall.args property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | args: object; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncall.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCall](./generative-ai.functioncall.md) > [name](./generative-ai.functioncall.name.md) 4 | 5 | ## FunctionCall.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallingconfig.allowedfunctionnames.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [allowedFunctionNames](./generative-ai.functioncallingconfig.allowedfunctionnames.md) 4 | 5 | ## FunctionCallingConfig.allowedFunctionNames property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | allowedFunctionNames?: string[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallingconfig.mode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [mode](./generative-ai.functioncallingconfig.mode.md) 4 | 5 | ## FunctionCallingConfig.mode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mode?: FunctionCallingMode; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [codeExecutionResult](./generative-ai.functioncallpart.codeexecutionresult.md) 4 | 5 | ## FunctionCallPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [executableCode](./generative-ai.functioncallpart.executablecode.md) 4 | 5 | ## FunctionCallPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [fileData](./generative-ai.functioncallpart.filedata.md) 4 | 5 | ## FunctionCallPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [functionCall](./generative-ai.functioncallpart.functioncall.md) 4 | 5 | ## FunctionCallPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall: FunctionCall; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [functionResponse](./generative-ai.functioncallpart.functionresponse.md) 4 | 5 | ## FunctionCallPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [inlineData](./generative-ai.functioncallpart.inlinedata.md) 4 | 5 | ## FunctionCallPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functioncallpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [text](./generative-ai.functioncallpart.text.md) 4 | 5 | ## FunctionCallPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functiondeclarationschema.required.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md) > [required](./generative-ai.functiondeclarationschema.required.md) 4 | 5 | ## FunctionDeclarationSchema.required property 6 | 7 | Optional. Array of required parameters. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | required?: string[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functiondeclarationschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md) > [type](./generative-ai.functiondeclarationschema.type.md) 4 | 5 | ## FunctionDeclarationSchema.type property 6 | 7 | The type of the parameter. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | type: SchemaType; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponse.name.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponse](./generative-ai.functionresponse.md) > [name](./generative-ai.functionresponse.name.md) 4 | 5 | ## FunctionResponse.name property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | name: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponse.response.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponse](./generative-ai.functionresponse.md) > [response](./generative-ai.functionresponse.response.md) 4 | 5 | ## FunctionResponse.response property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | response: object; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [codeExecutionResult](./generative-ai.functionresponsepart.codeexecutionresult.md) 4 | 5 | ## FunctionResponsePart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [executableCode](./generative-ai.functionresponsepart.executablecode.md) 4 | 5 | ## FunctionResponsePart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [fileData](./generative-ai.functionresponsepart.filedata.md) 4 | 5 | ## FunctionResponsePart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [functionCall](./generative-ai.functionresponsepart.functioncall.md) 4 | 5 | ## FunctionResponsePart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [functionResponse](./generative-ai.functionresponsepart.functionresponse.md) 4 | 5 | ## FunctionResponsePart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse: FunctionResponse; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [inlineData](./generative-ai.functionresponsepart.inlinedata.md) 4 | 5 | ## FunctionResponsePart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.functionresponsepart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [text](./generative-ai.functionresponsepart.text.md) 4 | 5 | ## FunctionResponsePart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.generativecontentblob.data.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeContentBlob](./generative-ai.generativecontentblob.md) > [data](./generative-ai.generativecontentblob.data.md) 4 | 5 | ## GenerativeContentBlob.data property 6 | 7 | Image as a base64 string. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | data: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.generativecontentblob.mimetype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeContentBlob](./generative-ai.generativecontentblob.md) > [mimeType](./generative-ai.generativecontentblob.mimetype.md) 4 | 5 | ## GenerativeContentBlob.mimeType property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | mimeType: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.googleaicachemanager.apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAICacheManager](./generative-ai.googleaicachemanager.md) > [apiKey](./generative-ai.googleaicachemanager.apikey.md) 4 | 5 | ## GoogleAICacheManager.apiKey property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | apiKey: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.googleaifilemanager.apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [apiKey](./generative-ai.googleaifilemanager.apikey.md) 4 | 5 | ## GoogleAIFileManager.apiKey property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | apiKey: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [codeExecutionResult](./generative-ai.inlinedatapart.codeexecutionresult.md) 4 | 5 | ## InlineDataPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [executableCode](./generative-ai.inlinedatapart.executablecode.md) 4 | 5 | ## InlineDataPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [fileData](./generative-ai.inlinedatapart.filedata.md) 4 | 5 | ## InlineDataPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [functionCall](./generative-ai.inlinedatapart.functioncall.md) 4 | 5 | ## InlineDataPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [functionResponse](./generative-ai.inlinedatapart.functionresponse.md) 4 | 5 | ## InlineDataPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [inlineData](./generative-ai.inlinedatapart.inlinedata.md) 4 | 5 | ## InlineDataPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData: GenerativeContentBlob; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.inlinedatapart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [text](./generative-ai.inlinedatapart.text.md) 4 | 5 | ## InlineDataPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.integerschema.format.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [IntegerSchema](./generative-ai.integerschema.md) > [format](./generative-ai.integerschema.format.md) 4 | 5 | ## IntegerSchema.format property 6 | 7 | Optional. The format of the number. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | format?: "int32" | "int64"; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.integerschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [IntegerSchema](./generative-ai.integerschema.md) > [type](./generative-ai.integerschema.type.md) 4 | 5 | ## IntegerSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.INTEGER; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listcacheresponse.cachedcontents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListCacheResponse](./generative-ai.listcacheresponse.md) > [cachedContents](./generative-ai.listcacheresponse.cachedcontents.md) 4 | 5 | ## ListCacheResponse.cachedContents property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | cachedContents: CachedContent[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listcacheresponse.nextpagetoken.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListCacheResponse](./generative-ai.listcacheresponse.md) > [nextPageToken](./generative-ai.listcacheresponse.nextpagetoken.md) 4 | 5 | ## ListCacheResponse.nextPageToken property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | nextPageToken?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listfilesresponse.files.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [files](./generative-ai.listfilesresponse.files.md) 4 | 5 | ## ListFilesResponse.files property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | files: FileMetadataResponse[]; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listfilesresponse.nextpagetoken.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [nextPageToken](./generative-ai.listfilesresponse.nextpagetoken.md) 4 | 5 | ## ListFilesResponse.nextPageToken property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | nextPageToken?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listparams.pagesize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageSize](./generative-ai.listparams.pagesize.md) 4 | 5 | ## ListParams.pageSize property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | pageSize?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.listparams.pagetoken.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageToken](./generative-ai.listparams.pagetoken.md) 4 | 5 | ## ListParams.pageToken property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | pageToken?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.numberschema.format.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [NumberSchema](./generative-ai.numberschema.md) > [format](./generative-ai.numberschema.format.md) 4 | 5 | ## NumberSchema.format property 6 | 7 | Optional. The format of the number. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | format?: "float" | "double"; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.numberschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [NumberSchema](./generative-ai.numberschema.md) > [type](./generative-ai.numberschema.type.md) 4 | 5 | ## NumberSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.NUMBER; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.objectschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ObjectSchema](./generative-ai.objectschema.md) > [type](./generative-ai.objectschema.type.md) 4 | 5 | ## ObjectSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.OBJECT; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.requestoptions.baseurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [baseUrl](./generative-ai.requestoptions.baseurl.md) 4 | 5 | ## RequestOptions.baseUrl property 6 | 7 | Base endpoint url. Defaults to "https://generativelanguage.googleapis.com" 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | baseUrl?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.requestoptions.customheaders.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [customHeaders](./generative-ai.requestoptions.customheaders.md) 4 | 5 | ## RequestOptions.customHeaders property 6 | 7 | Custom HTTP request headers. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | customHeaders?: Headers | Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.requestoptions.timeout.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [timeout](./generative-ai.requestoptions.timeout.md) 4 | 5 | ## RequestOptions.timeout property 6 | 7 | Request timeout in milliseconds. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | timeout?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.responseschema.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ResponseSchema](./generative-ai.responseschema.md) 4 | 5 | ## ResponseSchema type 6 | 7 | Schema passed to `GenerationConfig.responseSchema` 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | export type ResponseSchema = Schema; 13 | ``` 14 | **References:** [Schema](./generative-ai.schema.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.rpcstatus.code.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [code](./generative-ai.rpcstatus.code.md) 4 | 5 | ## RpcStatus.code property 6 | 7 | Error status code 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | code: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.rpcstatus.details.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [details](./generative-ai.rpcstatus.details.md) 4 | 5 | ## RpcStatus.details property 6 | 7 | A list of messages that carry the error details. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | details?: ErrorDetails[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.rpcstatus.message.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [message](./generative-ai.rpcstatus.message.md) 4 | 5 | ## RpcStatus.message property 6 | 7 | A developer-facing error message. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | message: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.stringschema.enum.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StringSchema](./generative-ai.stringschema.md) > [enum](./generative-ai.stringschema.enum.md) 4 | 5 | ## StringSchema.enum property 6 | 7 | If present, limits the result to one of the given values. 8 | 9 | **Signature:** 10 | 11 | ```typescript 12 | enum?: string[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.stringschema.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StringSchema](./generative-ai.stringschema.md) > [type](./generative-ai.stringschema.type.md) 4 | 5 | ## StringSchema.type property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | type: typeof SchemaType.STRING; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.codeexecutionresult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [codeExecutionResult](./generative-ai.textpart.codeexecutionresult.md) 4 | 5 | ## TextPart.codeExecutionResult property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | codeExecutionResult?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.executablecode.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [executableCode](./generative-ai.textpart.executablecode.md) 4 | 5 | ## TextPart.executableCode property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | executableCode?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.filedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [fileData](./generative-ai.textpart.filedata.md) 4 | 5 | ## TextPart.fileData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | fileData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.functioncall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [functionCall](./generative-ai.textpart.functioncall.md) 4 | 5 | ## TextPart.functionCall property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCall?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.functionresponse.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [functionResponse](./generative-ai.textpart.functionresponse.md) 4 | 5 | ## TextPart.functionResponse property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionResponse?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.inlinedata.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [inlineData](./generative-ai.textpart.inlinedata.md) 4 | 5 | ## TextPart.inlineData property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | inlineData?: never; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.textpart.text.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [text](./generative-ai.textpart.text.md) 4 | 5 | ## TextPart.text property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | text: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.toolconfig.functioncallingconfig.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ToolConfig](./generative-ai.toolconfig.md) > [functionCallingConfig](./generative-ai.toolconfig.functioncallingconfig.md) 4 | 5 | ## ToolConfig.functionCallingConfig property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | functionCallingConfig: FunctionCallingConfig; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/generative-ai.uploadfileresponse.file.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UploadFileResponse](./generative-ai.uploadfileresponse.md) > [file](./generative-ai.uploadfileresponse.file.md) 4 | 5 | ## UploadFileResponse.file property 6 | 7 | **Signature:** 8 | 9 | ```typescript 10 | file: FileMetadataResponse; 11 | ``` 12 | -------------------------------------------------------------------------------- /docs/reference/server/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@google/generative-ai](./generative-ai.md) | | 12 | 13 | -------------------------------------------------------------------------------- /samples/media/Big_Buck_Bunny.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/Big_Buck_Bunny.mp4 -------------------------------------------------------------------------------- /samples/media/firefighter.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/firefighter.jpg -------------------------------------------------------------------------------- /samples/media/gemini.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/gemini.pdf -------------------------------------------------------------------------------- /samples/media/jetpack.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/jetpack.jpg -------------------------------------------------------------------------------- /samples/media/piranha.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/piranha.jpg -------------------------------------------------------------------------------- /samples/media/samplesmall.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/samples/media/samplesmall.mp3 -------------------------------------------------------------------------------- /samples/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "module", 3 | "dependencies": { 4 | "@google/generative-ai": "*" 5 | }, 6 | "license": "Apache-2.0", 7 | "engines": { 8 | "node": ">=18.0.0" 9 | }, 10 | "scripts": { 11 | "check-samples": "node ./utils/check-samples.js", 12 | "import-comments": "node ./utils/insert-import-comments.js", 13 | "test": "npm run check-samples" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /samples/web/favicon.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /samples/web/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "module", 3 | "scripts": { 4 | "start": "node http-server.js", 5 | "http-server": "node http-server.js" 6 | }, 7 | "dependencies": { 8 | "@google/generative-ai": "*" 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /server/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@google/generative-ai-server", 3 | "description": "GoogleAI JS server-environment-only features", 4 | "main": "../dist/server/index.js", 5 | "browser": "../dist/server/index.mjs", 6 | "module": "../dist/server/index.mjs", 7 | "typings": "../dist/server/server.d.ts" 8 | } 9 | -------------------------------------------------------------------------------- /test-utils/cat.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/test-utils/cat.jpeg -------------------------------------------------------------------------------- /test-utils/cat.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hkirat/generative-ai-js/13466b31f3bb078aca0264b717c8a1ce0c6cbada/test-utils/cat.png -------------------------------------------------------------------------------- /test-utils/mock-responses/streaming-failure-empty-content.txt: -------------------------------------------------------------------------------- 1 | data: {"candidates": [{"content": {},"index": 0}],"promptFeedback": {"safetyRatings": [{"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT","probability": "NEGLIGIBLE"},{"category": "HARM_CATEGORY_HATE_SPEECH","probability": "NEGLIGIBLE"},{"category": "HARM_CATEGORY_HARASSMENT","probability": "NEGLIGIBLE"},{"category": "HARM_CATEGORY_DANGEROUS_CONTENT","probability": "NEGLIGIBLE"}]}} 2 | 3 | -------------------------------------------------------------------------------- /test-utils/mock-responses/streaming-failure-prompt-blocked-safety.txt: -------------------------------------------------------------------------------- 1 | data: {"promptFeedback": {"blockReason": "SAFETY","safetyRatings": [{"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT","probability": "NEGLIGIBLE"},{"category": "HARM_CATEGORY_HATE_SPEECH","probability": "HIGH"},{"category": "HARM_CATEGORY_HARASSMENT","probability": "NEGLIGIBLE"},{"category": "HARM_CATEGORY_DANGEROUS_CONTENT","probability": "NEGLIGIBLE"}]}} 2 | 3 | -------------------------------------------------------------------------------- /test-utils/mock-responses/unary-failure-citations.json: -------------------------------------------------------------------------------- 1 | { 2 | "candidates": [ 3 | { 4 | "finishReason": "RECITATION", 5 | "index": 0 6 | } 7 | ], 8 | "usageMetadata": { 9 | "promptTokenCount": 18, 10 | "totalTokenCount": 18 11 | }, 12 | "modelVersion": "gemini-1.5-flash-001" 13 | } -------------------------------------------------------------------------------- /test-utils/mock-responses/unary-failure-image-rejected.json: -------------------------------------------------------------------------------- 1 | { 2 | "error": { 3 | "code": 400, 4 | "message": "Request contains an invalid argument.", 5 | "status": "INVALID_ARGUMENT", 6 | "details": [ 7 | { 8 | "@type": "type.googleapis.com/google.rpc.DebugInfo", 9 | "detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid status photos.thumbnailer.Status.Code::5: Source image 0 too short" 10 | } 11 | ] 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "noImplicitAny": true, 4 | "module": "es2020", 5 | "target": "es2020", 6 | "allowJs": true, 7 | "moduleResolution": "node", 8 | "declaration": true, 9 | "outDir": "dist", 10 | "allowSyntheticDefaultImports": true 11 | } 12 | } 13 | --------------------------------------------------------------------------------