{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.38.2", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@google/generative-ai!", "docComment": "", "name": "@google/generative-ai", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@google/generative-ai!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Interface", "canonicalReference": "@google/generative-ai!BaseParams:interface", "docComment": "/**\n * Base parameters for a number of methods.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BaseParams " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "BaseParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!BaseParams#generationConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "generationConfig?: " }, { "kind": "Reference", "text": "GenerationConfig", "canonicalReference": "@google/generative-ai!GenerationConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "generationConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!BaseParams#safetySettings:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "safetySettings?: " }, { "kind": "Reference", "text": "SafetySetting", "canonicalReference": "@google/generative-ai!SafetySetting:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "safetySettings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!BatchEmbedContentsRequest:interface", "docComment": "/**\n * Params for calling {@link GenerativeModel.batchEmbedContents}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BatchEmbedContentsRequest " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "BatchEmbedContentsRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!BatchEmbedContentsRequest#requests:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "requests: " }, { "kind": "Reference", "text": "EmbedContentRequest", "canonicalReference": "@google/generative-ai!EmbedContentRequest:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requests", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!BatchEmbedContentsResponse:interface", "docComment": "/**\n * Response from calling {@link GenerativeModel.batchEmbedContents}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BatchEmbedContentsResponse " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "BatchEmbedContentsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!BatchEmbedContentsResponse#embeddings:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "embeddings: " }, { "kind": "Reference", "text": "ContentEmbedding", "canonicalReference": "@google/generative-ai!ContentEmbedding:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "embeddings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!BlockReason:enum", "docComment": "/**\n * Reason that a prompt was blocked.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum BlockReason " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "BlockReason", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!BlockReason.BLOCKED_REASON_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "BLOCKED_REASON_UNSPECIFIED = " }, { "kind": "Content", "text": "\"BLOCKED_REASON_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BLOCKED_REASON_UNSPECIFIED" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!BlockReason.OTHER:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "OTHER = " }, { "kind": "Content", "text": "\"OTHER\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "OTHER" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!BlockReason.SAFETY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SAFETY = " }, { "kind": "Content", "text": "\"SAFETY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SAFETY" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CachedContent:interface", "docComment": "/**\n * Describes `CachedContent` interface for sending to the server (if creating) or received from the server (using getters or list methods).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CachedContent extends " }, { "kind": "Reference", "text": "CachedContentBase", "canonicalReference": "@google/generative-ai!CachedContentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/server/caching.d.ts", "releaseTag": "Public", "name": "CachedContent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContent#createTime:member", "docComment": "/**\n * `CachedContent` creation time in ISO string format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createTime?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "createTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContent#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContent#ttl:member", "docComment": "/**\n * protobuf.Duration format (ex. \"3.0001s\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ttl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ttl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContent#updateTime:member", "docComment": "/**\n * `CachedContent` update time in ISO string format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateTime?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "updateTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CachedContentBase:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CachedContentBase " } ], "fileUrlPath": "dist/types/server/caching.d.ts", "releaseTag": "Public", "name": "CachedContentBase", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#contents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contents: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#displayName:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "displayName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#expireTime:member", "docComment": "/**\n * Expiration time in ISO string format. Specify either this or `ttlSeconds` when creating a `CachedContent`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "expireTime?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "expireTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#model:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "model?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "model", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#systemInstruction:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "systemInstruction?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Part", "canonicalReference": "@google/generative-ai!Part:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "systemInstruction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#toolConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolConfig?: " }, { "kind": "Reference", "text": "ToolConfig", "canonicalReference": "@google/generative-ai!ToolConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CachedContentBase#tools:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tools?: " }, { "kind": "Reference", "text": "Tool", "canonicalReference": "@google/generative-ai!Tool:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!ChatSession:class", "docComment": "/**\n * ChatSession class that enables sending chat messages and stores history of sent and received messages so far.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ChatSession " } ], "fileUrlPath": "dist/src/methods/chat-session.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ChatSession", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!ChatSession:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `ChatSession` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", model: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", params?: " }, { "kind": "Reference", "text": "StartChatParams", "canonicalReference": "@google/generative-ai!StartChatParams:interface" }, { "kind": "Content", "text": ", requestOptions?: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "apiKey", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "model", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "@google/generative-ai!ChatSession#getHistory:member(1)", "docComment": "/**\n * Gets the chat history so far. Blocked prompts are not added to history. Blocked candidates are not added to history, nor are the prompts that generated them.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHistory(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getHistory" }, { "kind": "Property", "canonicalReference": "@google/generative-ai!ChatSession#model:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "model: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "model", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!ChatSession#params:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "params?: " }, { "kind": "Reference", "text": "StartChatParams", "canonicalReference": "@google/generative-ai!StartChatParams:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "params", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!ChatSession#requestOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "requestOptions?: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "requestOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@google/generative-ai!ChatSession#sendMessage:member(1)", "docComment": "/**\n * Sends a chat message and receives a non-streaming {@link GenerateContentResult}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendMessage(request: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GenerateContentResult", "canonicalReference": "@google/generative-ai!GenerateContentResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "sendMessage" }, { "kind": "Method", "canonicalReference": "@google/generative-ai!ChatSession#sendMessageStream:member(1)", "docComment": "/**\n * Sends a chat message and receives the response as a {@link GenerateContentStreamResult} containing an iterable stream and a response promise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendMessageStream(request: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GenerateContentStreamResult", "canonicalReference": "@google/generative-ai!GenerateContentStreamResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "sendMessageStream" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CitationMetadata:interface", "docComment": "/**\n * Citation metadata that may be found on a {@link GenerateContentCandidate}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CitationMetadata " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "CitationMetadata", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CitationMetadata#citationSources:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "citationSources: " }, { "kind": "Reference", "text": "CitationSource", "canonicalReference": "@google/generative-ai!CitationSource:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "citationSources", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CitationSource:interface", "docComment": "/**\n * A single citation source.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CitationSource " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "CitationSource", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CitationSource#endIndex:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "endIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "endIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CitationSource#license:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "license?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "license", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CitationSource#startIndex:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "startIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "startIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CitationSource#uri:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "uri?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!Content:interface", "docComment": "/**\n * Content type for both prompts and response candidates.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Content " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "Content", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Content#parts:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "parts: " }, { "kind": "Reference", "text": "Part", "canonicalReference": "@google/generative-ai!Part:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Content#role:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "role: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "role", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!ContentEmbedding:interface", "docComment": "/**\n * A single content embedding.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContentEmbedding " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "ContentEmbedding", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ContentEmbedding#values:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "values: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CountTokensRequest:interface", "docComment": "/**\n * Params for calling {@link GenerativeModel.countTokens}.\n *\n * The request must contain either a {@link Content} array or a {@link GenerateContentRequest}, but not both. If both are provided then a {@link GoogleGenerativeAIRequestInputError} is thrown.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CountTokensRequest " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "CountTokensRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CountTokensRequest#contents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contents?: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "contents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CountTokensRequest#generateContentRequest:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "generateContentRequest?: " }, { "kind": "Reference", "text": "GenerateContentRequest", "canonicalReference": "@google/generative-ai!GenerateContentRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "generateContentRequest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!CountTokensResponse:interface", "docComment": "/**\n * Response from calling {@link GenerativeModel.countTokens}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CountTokensResponse " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "CountTokensResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!CountTokensResponse#totalTokens:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "totalTokens: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalTokens", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!EmbedContentRequest:interface", "docComment": "/**\n * Params for calling {@link GenerativeModel.embedContent}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedContentRequest " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "EmbedContentRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EmbedContentRequest#content:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EmbedContentRequest#taskType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "taskType?: " }, { "kind": "Reference", "text": "TaskType", "canonicalReference": "@google/generative-ai!TaskType:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "taskType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EmbedContentRequest#title:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!EmbedContentResponse:interface", "docComment": "/**\n * Response from calling {@link GenerativeModel.embedContent}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedContentResponse " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "EmbedContentResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EmbedContentResponse#embedding:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "embedding: " }, { "kind": "Reference", "text": "ContentEmbedding", "canonicalReference": "@google/generative-ai!ContentEmbedding:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "embedding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse:interface", "docComment": "/**\n * Response object wrapped with helper methods.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EnhancedGenerateContentResponse extends " }, { "kind": "Reference", "text": "GenerateContentResponse", "canonicalReference": "@google/generative-ai!GenerateContentResponse:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "EnhancedGenerateContentResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse#functionCall:member", "docComment": "/**\n * Deprecated: use `functionCalls()` instead.\n *\n * @deprecated\n *\n * - use `functionCalls()` instead\n */\n", "excerptTokens": [ { "kind": "Content", "text": "functionCall: " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "FunctionCall", "canonicalReference": "@google/generative-ai!FunctionCall:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse#functionCalls:member", "docComment": "/**\n * Returns function calls found in any `Part`s of the first candidate of the response, if available. Throws if the prompt or candidate was blocked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "functionCalls: " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "FunctionCall", "canonicalReference": "@google/generative-ai!FunctionCall:interface" }, { "kind": "Content", "text": "[] | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functionCalls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse#text:member", "docComment": "/**\n * Returns the text string assembled from all `Part`s of the first candidate of the response, if available. Throws if the prompt or candidate was blocked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "() => string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!ErrorDetails:interface", "docComment": "/**\n * Details object that may be included in an error response.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ErrorDetails " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "ErrorDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ErrorDetails#\"@type\":member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "\"@type\"?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"@type\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "IndexSignature", "canonicalReference": "@google/generative-ai!ErrorDetails:index(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ErrorDetails#domain:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "domain?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "domain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ErrorDetails#metadata:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "metadata?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ErrorDetails#reason:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "reason?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "reason", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FileData:interface", "docComment": "/**\n * Data pointing to a file uploaded with the Files API.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileData " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FileData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileData#fileUri:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileUri: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileUri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileData#mimeType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "mimeType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mimeType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FileDataPart:interface", "docComment": "/**\n * Content part interface if the part represents FunctionResponse.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileDataPart " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FileDataPart", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileDataPart#fileData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileData: " }, { "kind": "Reference", "text": "FileData", "canonicalReference": "@google/generative-ai!FileData:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileDataPart#functionCall:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCall?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileDataPart#functionResponse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionResponse?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionResponse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileDataPart#inlineData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inlineData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inlineData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FileDataPart#text:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!FinishReason:enum", "docComment": "/**\n * Reason that a candidate finished.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum FinishReason " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "FinishReason", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.FINISH_REASON_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "FINISH_REASON_UNSPECIFIED = " }, { "kind": "Content", "text": "\"FINISH_REASON_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "FINISH_REASON_UNSPECIFIED" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.MAX_TOKENS:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "MAX_TOKENS = " }, { "kind": "Content", "text": "\"MAX_TOKENS\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "MAX_TOKENS" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.OTHER:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "OTHER = " }, { "kind": "Content", "text": "\"OTHER\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "OTHER" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.RECITATION:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "RECITATION = " }, { "kind": "Content", "text": "\"RECITATION\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "RECITATION" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.SAFETY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SAFETY = " }, { "kind": "Content", "text": "\"SAFETY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SAFETY" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FinishReason.STOP:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "STOP = " }, { "kind": "Content", "text": "\"STOP\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "STOP" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionCall:interface", "docComment": "/**\n * A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionCall " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FunctionCall", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCall#args:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "args: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCall#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionCallingConfig:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionCallingConfig " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionCallingConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallingConfig#allowedFunctionNames:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "allowedFunctionNames?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowedFunctionNames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallingConfig#mode:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Reference", "text": "FunctionCallingMode", "canonicalReference": "@google/generative-ai!FunctionCallingMode:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!FunctionCallingMode:enum", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum FunctionCallingMode " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "FunctionCallingMode", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionCallingMode.ANY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ANY = " }, { "kind": "Content", "text": "\"ANY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "ANY" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionCallingMode.AUTO:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "AUTO = " }, { "kind": "Content", "text": "\"AUTO\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "AUTO" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionCallingMode.MODE_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "MODE_UNSPECIFIED = " }, { "kind": "Content", "text": "\"MODE_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "MODE_UNSPECIFIED" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionCallingMode.NONE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "NONE = " }, { "kind": "Content", "text": "\"NONE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "NONE" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionCallPart:interface", "docComment": "/**\n * Content part interface if the part represents FunctionResponse.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionCallPart " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FunctionCallPart", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallPart#fileData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fileData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallPart#functionCall:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCall: " }, { "kind": "Reference", "text": "FunctionCall", "canonicalReference": "@google/generative-ai!FunctionCall:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallPart#functionResponse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionResponse?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionResponse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallPart#inlineData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inlineData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inlineData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionCallPart#text:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionDeclaration:interface", "docComment": "/**\n * Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare interface FunctionDeclaration " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionDeclaration", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclaration#description:member", "docComment": "/**\n * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclaration#name:member", "docComment": "/**\n * The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a max length of 64.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclaration#parameters:member", "docComment": "/**\n * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset.\n *\n * @example\n *\n * with 1 required and 1 optional parameter: type: OBJECT properties:\n * ```\n * param1:\n *\n * type: STRING\n * param2:\n *\n * type: INTEGER\n * required:\n *\n * - param1\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parameters?: " }, { "kind": "Reference", "text": "FunctionDeclarationSchema", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "parameters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema:interface", "docComment": "/**\n * Schema for parameters passed to {@link FunctionDeclaration.parameters}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionDeclarationSchema " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionDeclarationSchema", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema#description:member", "docComment": "/**\n * Optional. Description of the parameter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema#properties:member", "docComment": "/**\n * The format of the parameter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties: " }, { "kind": "Content", "text": "{\n [k: string]: " }, { "kind": "Reference", "text": "FunctionDeclarationSchemaProperty", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaProperty:interface" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema#required:member", "docComment": "/**\n * Optional. Array of required parameters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "required?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "required", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema#type:member", "docComment": "/**\n * The type of the parameter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "FunctionDeclarationSchemaType", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaProperty:interface", "docComment": "/**\n * Schema for top-level function declaration\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionDeclarationSchemaProperty extends " }, { "kind": "Reference", "text": "Schema", "canonicalReference": "@google/generative-ai!Schema:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionDeclarationSchemaProperty", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType:enum", "docComment": "/**\n * Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum FunctionDeclarationSchemaType " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionDeclarationSchemaType", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.ARRAY:member", "docComment": "/**\n * Array type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ARRAY = " }, { "kind": "Content", "text": "\"ARRAY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "ARRAY" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.BOOLEAN:member", "docComment": "/**\n * Boolean type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BOOLEAN = " }, { "kind": "Content", "text": "\"BOOLEAN\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BOOLEAN" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.INTEGER:member", "docComment": "/**\n * Integer type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "INTEGER = " }, { "kind": "Content", "text": "\"INTEGER\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "INTEGER" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.NUMBER:member", "docComment": "/**\n * Number type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NUMBER = " }, { "kind": "Content", "text": "\"NUMBER\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "NUMBER" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.OBJECT:member", "docComment": "/**\n * Object type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "OBJECT = " }, { "kind": "Content", "text": "\"OBJECT\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "OBJECT" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType.STRING:member", "docComment": "/**\n * String type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "STRING = " }, { "kind": "Content", "text": "\"STRING\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "STRING" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionDeclarationsTool:interface", "docComment": "/**\n * A FunctionDeclarationsTool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare interface FunctionDeclarationsTool " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "FunctionDeclarationsTool", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionDeclarationsTool#functionDeclarations:member", "docComment": "/**\n * Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating [FunctionCall][content.part.functionCall] in the response. User should provide a [FunctionResponse][content.part.functionResponse] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "functionDeclarations?: " }, { "kind": "Reference", "text": "FunctionDeclaration", "canonicalReference": "@google/generative-ai!FunctionDeclaration:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionDeclarations", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionResponse:interface", "docComment": "/**\n * The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionResponse " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FunctionResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponse#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponse#response:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "response: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!FunctionResponsePart:interface", "docComment": "/**\n * Content part interface if the part represents FunctionResponse.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FunctionResponsePart " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "FunctionResponsePart", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponsePart#fileData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fileData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponsePart#functionCall:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCall?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponsePart#functionResponse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionResponse: " }, { "kind": "Reference", "text": "FunctionResponse", "canonicalReference": "@google/generative-ai!FunctionResponse:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functionResponse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponsePart#inlineData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inlineData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inlineData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!FunctionResponsePart#text:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerateContentCandidate:interface", "docComment": "/**\n * A candidate returned as part of a {@link GenerateContentResponse}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerateContentCandidate " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "GenerateContentCandidate", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#citationMetadata:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "citationMetadata?: " }, { "kind": "Reference", "text": "CitationMetadata", "canonicalReference": "@google/generative-ai!CitationMetadata:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "citationMetadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#content:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#finishMessage:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "finishMessage?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "finishMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#finishReason:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "finishReason?: " }, { "kind": "Reference", "text": "FinishReason", "canonicalReference": "@google/generative-ai!FinishReason:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "finishReason", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#index:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentCandidate#safetyRatings:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "safetyRatings?: " }, { "kind": "Reference", "text": "SafetyRating", "canonicalReference": "@google/generative-ai!SafetyRating:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "safetyRatings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerateContentRequest:interface", "docComment": "/**\n * Request sent to `generateContent` endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerateContentRequest extends " }, { "kind": "Reference", "text": "BaseParams", "canonicalReference": "@google/generative-ai!BaseParams:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "GenerateContentRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentRequest#cachedContent:member", "docComment": "/**\n * This is the name of a `CachedContent` and not the cache object itself.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cachedContent?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cachedContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentRequest#contents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contents: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentRequest#systemInstruction:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "systemInstruction?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Part", "canonicalReference": "@google/generative-ai!Part:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "systemInstruction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentRequest#toolConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolConfig?: " }, { "kind": "Reference", "text": "ToolConfig", "canonicalReference": "@google/generative-ai!ToolConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentRequest#tools:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tools?: " }, { "kind": "Reference", "text": "Tool", "canonicalReference": "@google/generative-ai!Tool:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerateContentResponse:interface", "docComment": "/**\n * Individual response from {@link GenerativeModel.generateContent} and {@link GenerativeModel.generateContentStream}. `generateContentStream()` will return one in each chunk until the stream is done.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerateContentResponse " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "GenerateContentResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentResponse#candidates:member", "docComment": "/**\n * Candidate responses from the model.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "candidates?: " }, { "kind": "Reference", "text": "GenerateContentCandidate", "canonicalReference": "@google/generative-ai!GenerateContentCandidate:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "candidates", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentResponse#promptFeedback:member", "docComment": "/**\n * The prompt's feedback related to the content filters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promptFeedback?: " }, { "kind": "Reference", "text": "PromptFeedback", "canonicalReference": "@google/generative-ai!PromptFeedback:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "promptFeedback", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentResponse#usageMetadata:member", "docComment": "/**\n * Metadata on the generation request's token usage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "usageMetadata?: " }, { "kind": "Reference", "text": "UsageMetadata", "canonicalReference": "@google/generative-ai!UsageMetadata:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "usageMetadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerateContentResult:interface", "docComment": "/**\n * Result object returned from generateContent() call.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerateContentResult " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "GenerateContentResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentResult#response:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "response: " }, { "kind": "Reference", "text": "EnhancedGenerateContentResponse", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerateContentStreamResult:interface", "docComment": "/**\n * Result object returned from generateContentStream() call. Iterate over `stream` to get chunks as they come in and/or use the `response` promise to get the aggregated response when the stream is done.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerateContentStreamResult " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "GenerateContentStreamResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentStreamResult#response:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "response: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EnhancedGenerateContentResponse", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerateContentStreamResult#stream:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stream: " }, { "kind": "Reference", "text": "AsyncGenerator", "canonicalReference": "!AsyncGenerator:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EnhancedGenerateContentResponse", "canonicalReference": "@google/generative-ai!EnhancedGenerateContentResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerationConfig:interface", "docComment": "/**\n * Config options for content-related requests\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerationConfig " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "GenerationConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#candidateCount:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "candidateCount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "candidateCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#maxOutputTokens:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "maxOutputTokens?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxOutputTokens", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#responseMimeType:member", "docComment": "/**\n * Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseMimeType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseMimeType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#responseSchema:member", "docComment": "/**\n * Output response schema of the generated candidate text. Note: This only applies when the specified `responseMIMEType` supports a schema; currently this is limited to `application/json`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseSchema?: " }, { "kind": "Reference", "text": "ResponseSchema", "canonicalReference": "@google/generative-ai!ResponseSchema:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseSchema", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#stopSequences:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stopSequences?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "stopSequences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#temperature:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "temperature?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "temperature", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#topK:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "topK?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "topK", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerationConfig#topP:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "topP?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "topP", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!GenerativeContentBlob:interface", "docComment": "/**\n * Interface for sending an image.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GenerativeContentBlob " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "GenerativeContentBlob", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerativeContentBlob#data:member", "docComment": "/**\n * Image as a base64 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!GenerativeContentBlob#mimeType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "mimeType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mimeType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GenerativeModel:class", "docComment": "/**\n * Class for generative model APIs.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GenerativeModel " } ], "fileUrlPath": "dist/src/models/generative-model.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GenerativeModel", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!GenerativeModel:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `GenerativeModel` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", modelParams: " }, { "kind": "Reference", "text": "ModelParams", "canonicalReference": "@google/generative-ai!ModelParams:interface" }, { "kind": "Content", "text": ", requestOptions?: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "apiKey", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modelParams", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#apiKey:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "apiKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#batchEmbedContents:member(1)", "docComment": "/**\n * Embeds an array of {@link EmbedContentRequest}s.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "batchEmbedContents(batchEmbedContentRequest: " }, { "kind": "Reference", "text": "BatchEmbedContentsRequest", "canonicalReference": "@google/generative-ai!BatchEmbedContentsRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BatchEmbedContentsResponse", "canonicalReference": "@google/generative-ai!BatchEmbedContentsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "batchEmbedContentRequest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "batchEmbedContents" }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#cachedContent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "cachedContent: " }, { "kind": "Reference", "text": "CachedContent", "canonicalReference": "@google/generative-ai!CachedContent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cachedContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#countTokens:member(1)", "docComment": "/**\n * Counts the tokens in the provided request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "countTokens(request: " }, { "kind": "Reference", "text": "CountTokensRequest", "canonicalReference": "@google/generative-ai!CountTokensRequest:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CountTokensResponse", "canonicalReference": "@google/generative-ai!CountTokensResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "countTokens" }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#embedContent:member(1)", "docComment": "/**\n * Embeds the provided content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "embedContent(request: " }, { "kind": "Reference", "text": "EmbedContentRequest", "canonicalReference": "@google/generative-ai!EmbedContentRequest:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EmbedContentResponse", "canonicalReference": "@google/generative-ai!EmbedContentResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "embedContent" }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#generateContent:member(1)", "docComment": "/**\n * Makes a single non-streaming call to the model and returns an object containing a single {@link GenerateContentResponse}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "generateContent(request: " }, { "kind": "Reference", "text": "GenerateContentRequest", "canonicalReference": "@google/generative-ai!GenerateContentRequest:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GenerateContentResult", "canonicalReference": "@google/generative-ai!GenerateContentResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "generateContent" }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#generateContentStream:member(1)", "docComment": "/**\n * Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "generateContentStream(request: " }, { "kind": "Reference", "text": "GenerateContentRequest", "canonicalReference": "@google/generative-ai!GenerateContentRequest:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GenerateContentStreamResult", "canonicalReference": "@google/generative-ai!GenerateContentStreamResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "generateContentStream" }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#generationConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "generationConfig: " }, { "kind": "Reference", "text": "GenerationConfig", "canonicalReference": "@google/generative-ai!GenerationConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "generationConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#model:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "model: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "model", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#requestOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "requestOptions: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#safetySettings:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "safetySettings: " }, { "kind": "Reference", "text": "SafetySetting", "canonicalReference": "@google/generative-ai!SafetySetting:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "safetySettings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GenerativeModel#startChat:member(1)", "docComment": "/**\n * Gets a new {@link ChatSession} instance which can be used for multi-turn chats.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startChat(startChatParams?: " }, { "kind": "Reference", "text": "StartChatParams", "canonicalReference": "@google/generative-ai!StartChatParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ChatSession", "canonicalReference": "@google/generative-ai!ChatSession:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "startChatParams", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "startChat" }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#systemInstruction:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "systemInstruction?: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "systemInstruction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#toolConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolConfig?: " }, { "kind": "Reference", "text": "ToolConfig", "canonicalReference": "@google/generative-ai!ToolConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GenerativeModel#tools:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tools?: " }, { "kind": "Reference", "text": "Tool", "canonicalReference": "@google/generative-ai!Tool:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GoogleGenerativeAI:class", "docComment": "/**\n * Top-level class for this SDK\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GoogleGenerativeAI " } ], "fileUrlPath": "dist/src/gen-ai.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GoogleGenerativeAI", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!GoogleGenerativeAI:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `GoogleGenerativeAI` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "apiKey", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GoogleGenerativeAI#apiKey:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "apiKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GoogleGenerativeAI#getGenerativeModel:member(1)", "docComment": "/**\n * Gets a {@link GenerativeModel} instance for the provided model name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGenerativeModel(modelParams: " }, { "kind": "Reference", "text": "ModelParams", "canonicalReference": "@google/generative-ai!ModelParams:interface" }, { "kind": "Content", "text": ", requestOptions?: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "GenerativeModel", "canonicalReference": "@google/generative-ai!GenerativeModel:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "modelParams", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "getGenerativeModel" }, { "kind": "Method", "canonicalReference": "@google/generative-ai!GoogleGenerativeAI#getGenerativeModelFromCachedContent:member(1)", "docComment": "/**\n * Creates a {@link GenerativeModel} instance from provided content cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGenerativeModelFromCachedContent(cachedContent: " }, { "kind": "Reference", "text": "CachedContent", "canonicalReference": "@google/generative-ai!CachedContent:interface" }, { "kind": "Content", "text": ", requestOptions?: " }, { "kind": "Reference", "text": "RequestOptions", "canonicalReference": "@google/generative-ai!RequestOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "GenerativeModel", "canonicalReference": "@google/generative-ai!GenerativeModel:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "cachedContent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "getGenerativeModelFromCachedContent" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIError:class", "docComment": "/**\n * Basic error type for this SDK.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GoogleGenerativeAIError extends " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/src/errors.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GoogleGenerativeAIError", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIError:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `GoogleGenerativeAIError` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIFetchError:class", "docComment": "/**\n * Error class covering HTTP errors when calling the server. Includes HTTP status, statusText, and optional details, if provided in the server response.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GoogleGenerativeAIFetchError extends " }, { "kind": "Reference", "text": "GoogleGenerativeAIError", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIError:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/src/errors.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GoogleGenerativeAIFetchError", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIFetchError:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `GoogleGenerativeAIFetchError` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", status?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", statusText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", errorDetails?: " }, { "kind": "Reference", "text": "ErrorDetails", "canonicalReference": "@google/generative-ai!ErrorDetails:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "status", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "statusText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "errorDetails", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIFetchError#errorDetails:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "errorDetails?: " }, { "kind": "Reference", "text": "ErrorDetails", "canonicalReference": "@google/generative-ai!ErrorDetails:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "errorDetails", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIFetchError#status:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "status?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "status", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIFetchError#statusText:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "statusText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "statusText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIRequestInputError:class", "docComment": "/**\n * Errors in the contents of a request originating from user input.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GoogleGenerativeAIRequestInputError extends " }, { "kind": "Reference", "text": "GoogleGenerativeAIError", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIError:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/src/errors.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GoogleGenerativeAIRequestInputError", "preserveMemberOrder": false, "members": [], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIResponseError:class", "docComment": "/**\n * Errors in the contents of a response from the model. This includes parsing errors, or responses including a safety block reason.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GoogleGenerativeAIResponseError extends " }, { "kind": "Reference", "text": "GoogleGenerativeAIError", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIError:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/src/errors.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "GoogleGenerativeAIResponseError", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIResponseError:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `GoogleGenerativeAIResponseError` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", response?: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "response", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@google/generative-ai!GoogleGenerativeAIResponseError#response:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "response?: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!HarmBlockThreshold:enum", "docComment": "/**\n * Threshold above which a prompt or candidate will be blocked.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum HarmBlockThreshold " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "HarmBlockThreshold", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmBlockThreshold.BLOCK_LOW_AND_ABOVE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "BLOCK_LOW_AND_ABOVE = " }, { "kind": "Content", "text": "\"BLOCK_LOW_AND_ABOVE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BLOCK_LOW_AND_ABOVE" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "BLOCK_MEDIUM_AND_ABOVE = " }, { "kind": "Content", "text": "\"BLOCK_MEDIUM_AND_ABOVE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BLOCK_MEDIUM_AND_ABOVE" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmBlockThreshold.BLOCK_NONE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "BLOCK_NONE = " }, { "kind": "Content", "text": "\"BLOCK_NONE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BLOCK_NONE" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmBlockThreshold.BLOCK_ONLY_HIGH:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "BLOCK_ONLY_HIGH = " }, { "kind": "Content", "text": "\"BLOCK_ONLY_HIGH\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "BLOCK_ONLY_HIGH" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmBlockThreshold.HARM_BLOCK_THRESHOLD_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_BLOCK_THRESHOLD_UNSPECIFIED = " }, { "kind": "Content", "text": "\"HARM_BLOCK_THRESHOLD_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_BLOCK_THRESHOLD_UNSPECIFIED" } ] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!HarmCategory:enum", "docComment": "/**\n * Harm categories that would cause prompts or candidates to be blocked.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum HarmCategory " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "HarmCategory", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_CATEGORY_DANGEROUS_CONTENT = " }, { "kind": "Content", "text": "\"HARM_CATEGORY_DANGEROUS_CONTENT\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_CATEGORY_DANGEROUS_CONTENT" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmCategory.HARM_CATEGORY_HARASSMENT:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_CATEGORY_HARASSMENT = " }, { "kind": "Content", "text": "\"HARM_CATEGORY_HARASSMENT\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_CATEGORY_HARASSMENT" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmCategory.HARM_CATEGORY_HATE_SPEECH:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_CATEGORY_HATE_SPEECH = " }, { "kind": "Content", "text": "\"HARM_CATEGORY_HATE_SPEECH\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_CATEGORY_HATE_SPEECH" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_CATEGORY_SEXUALLY_EXPLICIT = " }, { "kind": "Content", "text": "\"HARM_CATEGORY_SEXUALLY_EXPLICIT\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_CATEGORY_SEXUALLY_EXPLICIT" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmCategory.HARM_CATEGORY_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_CATEGORY_UNSPECIFIED = " }, { "kind": "Content", "text": "\"HARM_CATEGORY_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_CATEGORY_UNSPECIFIED" } ] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!HarmProbability:enum", "docComment": "/**\n * Probability that a prompt or candidate matches a harm category.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum HarmProbability " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "HarmProbability", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmProbability.HARM_PROBABILITY_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HARM_PROBABILITY_UNSPECIFIED = " }, { "kind": "Content", "text": "\"HARM_PROBABILITY_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HARM_PROBABILITY_UNSPECIFIED" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmProbability.HIGH:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HIGH = " }, { "kind": "Content", "text": "\"HIGH\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "HIGH" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmProbability.LOW:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "LOW = " }, { "kind": "Content", "text": "\"LOW\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "LOW" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmProbability.MEDIUM:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "MEDIUM = " }, { "kind": "Content", "text": "\"MEDIUM\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "MEDIUM" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!HarmProbability.NEGLIGIBLE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "NEGLIGIBLE = " }, { "kind": "Content", "text": "\"NEGLIGIBLE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "NEGLIGIBLE" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!InlineDataPart:interface", "docComment": "/**\n * Content part interface if the part represents an image.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InlineDataPart " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "InlineDataPart", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!InlineDataPart#fileData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fileData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!InlineDataPart#functionCall:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCall?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!InlineDataPart#functionResponse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionResponse?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionResponse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!InlineDataPart#inlineData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inlineData: " }, { "kind": "Reference", "text": "GenerativeContentBlob", "canonicalReference": "@google/generative-ai!GenerativeContentBlob:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inlineData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!InlineDataPart#text:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!ModelParams:interface", "docComment": "/**\n * Params passed to {@link GoogleGenerativeAI.getGenerativeModel}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ModelParams extends " }, { "kind": "Reference", "text": "BaseParams", "canonicalReference": "@google/generative-ai!BaseParams:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "ModelParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ModelParams#cachedContent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "cachedContent?: " }, { "kind": "Reference", "text": "CachedContent", "canonicalReference": "@google/generative-ai!CachedContent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cachedContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ModelParams#model:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "model: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "model", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ModelParams#systemInstruction:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "systemInstruction?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Part", "canonicalReference": "@google/generative-ai!Part:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "systemInstruction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ModelParams#toolConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolConfig?: " }, { "kind": "Reference", "text": "ToolConfig", "canonicalReference": "@google/generative-ai!ToolConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ModelParams#tools:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tools?: " }, { "kind": "Reference", "text": "Tool", "canonicalReference": "@google/generative-ai!Tool:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "@google/generative-ai!Part:type", "docComment": "/**\n * Content part - includes text or image part types.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Part = " }, { "kind": "Reference", "text": "TextPart", "canonicalReference": "@google/generative-ai!TextPart:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "InlineDataPart", "canonicalReference": "@google/generative-ai!InlineDataPart:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FunctionCallPart", "canonicalReference": "@google/generative-ai!FunctionCallPart:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FunctionResponsePart", "canonicalReference": "@google/generative-ai!FunctionResponsePart:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FileDataPart", "canonicalReference": "@google/generative-ai!FileDataPart:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "Part", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "Variable", "canonicalReference": "@google/generative-ai!POSSIBLE_ROLES:var", "docComment": "/**\n * Possible roles.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "POSSIBLE_ROLES: " }, { "kind": "Content", "text": "readonly [\"user\", \"model\", \"function\", \"system\"]" } ], "fileUrlPath": "dist/types/enums.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "POSSIBLE_ROLES", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!PromptFeedback:interface", "docComment": "/**\n * If the prompt was blocked, this will be populated with `blockReason` and the relevant `safetyRatings`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PromptFeedback " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "PromptFeedback", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!PromptFeedback#blockReason:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blockReason: " }, { "kind": "Reference", "text": "BlockReason", "canonicalReference": "@google/generative-ai!BlockReason:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "blockReason", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!PromptFeedback#blockReasonMessage:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blockReasonMessage?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blockReasonMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!PromptFeedback#safetyRatings:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "safetyRatings: " }, { "kind": "Reference", "text": "SafetyRating", "canonicalReference": "@google/generative-ai!SafetyRating:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "safetyRatings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!RequestOptions:interface", "docComment": "/**\n * Params passed to getGenerativeModel() or GoogleAIFileManager().\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RequestOptions " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "RequestOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!RequestOptions#apiClient:member", "docComment": "/**\n * Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "apiClient?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "apiClient", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!RequestOptions#apiVersion:member", "docComment": "/**\n * Version of API endpoint to call (e.g. \"v1\" or \"v1beta\"). If not specified, defaults to latest stable version.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "apiVersion?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "apiVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!RequestOptions#baseUrl:member", "docComment": "/**\n * Base endpoint url. Defaults to \"https://generativelanguage.googleapis.com\"\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baseUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "baseUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!RequestOptions#customHeaders:member", "docComment": "/**\n * Custom HTTP request headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "customHeaders?: " }, { "kind": "Reference", "text": "Headers", "canonicalReference": "!Headers:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "customHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!RequestOptions#timeout:member", "docComment": "/**\n * Request timeout in milliseconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timeout?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "timeout", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!ResponseSchema:interface", "docComment": "/**\n * Schema passed to `GenerationConfig.responseSchema`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResponseSchema extends " }, { "kind": "Reference", "text": "Schema", "canonicalReference": "@google/generative-ai!Schema:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "ResponseSchema", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!SafetyRating:interface", "docComment": "/**\n * A safety rating associated with a {@link GenerateContentCandidate}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SafetyRating " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "SafetyRating", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!SafetyRating#category:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "category: " }, { "kind": "Reference", "text": "HarmCategory", "canonicalReference": "@google/generative-ai!HarmCategory:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "category", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!SafetyRating#probability:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "probability: " }, { "kind": "Reference", "text": "HarmProbability", "canonicalReference": "@google/generative-ai!HarmProbability:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "probability", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!SafetySetting:interface", "docComment": "/**\n * Safety setting that can be sent as part of request parameters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SafetySetting " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "SafetySetting", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!SafetySetting#category:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "category: " }, { "kind": "Reference", "text": "HarmCategory", "canonicalReference": "@google/generative-ai!HarmCategory:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "category", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!SafetySetting#threshold:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "threshold: " }, { "kind": "Reference", "text": "HarmBlockThreshold", "canonicalReference": "@google/generative-ai!HarmBlockThreshold:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "threshold", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!Schema:interface", "docComment": "/**\n * Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Schema " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "Schema", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#description:member", "docComment": "/**\n * Optional. The description of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#enum:member", "docComment": "/**\n * Optional. The enum of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enum?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enum", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#example:member", "docComment": "/**\n * Optional. The example of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "example?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "example", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#format:member", "docComment": "/**\n * Optional. The format of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "format?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "format", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#items:member", "docComment": "/**\n * Optional. The items of the property. {@link FunctionDeclarationSchema}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items?: " }, { "kind": "Reference", "text": "FunctionDeclarationSchema", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#nullable:member", "docComment": "/**\n * Optional. Whether the property is nullable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nullable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nullable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#properties:member", "docComment": "/**\n * Optional. Map of {@link FunctionDeclarationSchema}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Content", "text": "{\n [k: string]: " }, { "kind": "Reference", "text": "FunctionDeclarationSchema", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchema:interface" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#required:member", "docComment": "/**\n * Optional. Array of required property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "required?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "required", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!Schema#type:member", "docComment": "/**\n * Optional. The type of the property. {@link FunctionDeclarationSchemaType}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Reference", "text": "FunctionDeclarationSchemaType", "canonicalReference": "@google/generative-ai!FunctionDeclarationSchemaType:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!StartChatParams:interface", "docComment": "/**\n * Params for {@link GenerativeModel.startChat}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StartChatParams extends " }, { "kind": "Reference", "text": "BaseParams", "canonicalReference": "@google/generative-ai!BaseParams:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/types/requests.d.ts", "releaseTag": "Public", "name": "StartChatParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!StartChatParams#cachedContent:member", "docComment": "/**\n * This is the name of a `CachedContent` and not the cache object itself.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cachedContent?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cachedContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!StartChatParams#history:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "history?: " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "history", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!StartChatParams#systemInstruction:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "systemInstruction?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Part", "canonicalReference": "@google/generative-ai!Part:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Content", "canonicalReference": "@google/generative-ai!Content:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "systemInstruction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!StartChatParams#toolConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolConfig?: " }, { "kind": "Reference", "text": "ToolConfig", "canonicalReference": "@google/generative-ai!ToolConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!StartChatParams#tools:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tools?: " }, { "kind": "Reference", "text": "Tool", "canonicalReference": "@google/generative-ai!Tool:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Enum", "canonicalReference": "@google/generative-ai!TaskType:enum", "docComment": "/**\n * Task type for embedding content.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum TaskType " } ], "fileUrlPath": "dist/types/enums.d.ts", "releaseTag": "Public", "name": "TaskType", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.CLASSIFICATION:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "CLASSIFICATION = " }, { "kind": "Content", "text": "\"CLASSIFICATION\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "CLASSIFICATION" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.CLUSTERING:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "CLUSTERING = " }, { "kind": "Content", "text": "\"CLUSTERING\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "CLUSTERING" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.RETRIEVAL_DOCUMENT:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "RETRIEVAL_DOCUMENT = " }, { "kind": "Content", "text": "\"RETRIEVAL_DOCUMENT\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "RETRIEVAL_DOCUMENT" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.RETRIEVAL_QUERY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "RETRIEVAL_QUERY = " }, { "kind": "Content", "text": "\"RETRIEVAL_QUERY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "RETRIEVAL_QUERY" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.SEMANTIC_SIMILARITY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SEMANTIC_SIMILARITY = " }, { "kind": "Content", "text": "\"SEMANTIC_SIMILARITY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SEMANTIC_SIMILARITY" }, { "kind": "EnumMember", "canonicalReference": "@google/generative-ai!TaskType.TASK_TYPE_UNSPECIFIED:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "TASK_TYPE_UNSPECIFIED = " }, { "kind": "Content", "text": "\"TASK_TYPE_UNSPECIFIED\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TASK_TYPE_UNSPECIFIED" } ] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!TextPart:interface", "docComment": "/**\n * Content part interface if the part represents a text string.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextPart " } ], "fileUrlPath": "dist/types/content.d.ts", "releaseTag": "Public", "name": "TextPart", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!TextPart#fileData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fileData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fileData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!TextPart#functionCall:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCall?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionCall", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!TextPart#functionResponse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionResponse?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "functionResponse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!TextPart#inlineData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inlineData?: " }, { "kind": "Content", "text": "never" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inlineData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!TextPart#text:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@google/generative-ai!Tool:type", "docComment": "/**\n * Defines a tool that model can call to access external knowledge.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type Tool = " }, { "kind": "Reference", "text": "FunctionDeclarationsTool", "canonicalReference": "@google/generative-ai!FunctionDeclarationsTool:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "Tool", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!ToolConfig:interface", "docComment": "/**\n * Tool config. This config is shared for all tools provided in the request.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ToolConfig " } ], "fileUrlPath": "dist/types/function-calling.d.ts", "releaseTag": "Public", "name": "ToolConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!ToolConfig#functionCallingConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "functionCallingConfig: " }, { "kind": "Reference", "text": "FunctionCallingConfig", "canonicalReference": "@google/generative-ai!FunctionCallingConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functionCallingConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@google/generative-ai!UsageMetadata:interface", "docComment": "/**\n * Metadata on the generation request's token usage.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UsageMetadata " } ], "fileUrlPath": "dist/types/responses.d.ts", "releaseTag": "Public", "name": "UsageMetadata", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!UsageMetadata#candidatesTokenCount:member", "docComment": "/**\n * Total number of tokens across the generated candidates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "candidatesTokenCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "candidatesTokenCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!UsageMetadata#promptTokenCount:member", "docComment": "/**\n * Number of tokens in the prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promptTokenCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promptTokenCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@google/generative-ai!UsageMetadata#totalTokenCount:member", "docComment": "/**\n * Total token count for the generation request (prompt + candidates).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "totalTokenCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalTokenCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] } ] } ] }