@google-ai/generativelanguage
Version:
Generative Language API client for Node.js
252 lines (251 loc) • 13.4 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import * as protos from '../../protos/protos';
/**
* API for using Generative Language Models (GLMs) trained to generate text.
*
* Also known as Large Language Models (LLM)s, these generate text given an
* input prompt from the user.
* @class
* @memberof v1beta2
*/
export declare class TextServiceClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
textServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of TextServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new TextServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): never[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Generates a response from the model given an input message.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.model
* Required. The model name to use with the format name=models/{model}.
* @param {google.ai.generativelanguage.v1beta2.TextPrompt} request.prompt
* Required. The free-form input text given to the model as a prompt.
*
* Given a prompt, the model will generate a TextCompletion response it
* predicts as the completion of the input text.
* @param {number} request.temperature
* Controls the randomness of the output.
* Note: The default value varies by model, see the `Model.temperature`
* attribute of the `Model` returned the `getModel` function.
*
* Values can range from [0.0,1.0],
* inclusive. A value closer to 1.0 will produce responses that are more
* varied and creative, while a value closer to 0.0 will typically result in
* more straightforward responses from the model.
* @param {number} request.candidateCount
* Number of generated responses to return.
*
* This value must be between [1, 8], inclusive. If unset, this will default
* to 1.
* @param {number} request.maxOutputTokens
* The maximum number of tokens to include in a candidate.
*
* If unset, this will default to 64.
* @param {number} request.topP
* The maximum cumulative probability of tokens to consider when sampling.
*
* The model uses combined Top-k and nucleus sampling.
*
* Tokens are sorted based on their assigned probabilities so that only the
* most liekly tokens are considered. Top-k sampling directly limits the
* maximum number of tokens to consider, while Nucleus sampling limits number
* of tokens based on the cumulative probability.
*
* Note: The default value varies by model, see the `Model.top_p`
* attribute of the `Model` returned the `getModel` function.
* @param {number} request.topK
* The maximum number of tokens to consider when sampling.
*
* The model uses combined Top-k and nucleus sampling.
*
* Top-k sampling considers the set of `top_k` most probable tokens.
* Defaults to 40.
*
* Note: The default value varies by model, see the `Model.top_k`
* attribute of the `Model` returned the `getModel` function.
* @param {number[]} request.safetySettings
* A list of unique `SafetySetting` instances for blocking unsafe content.
*
* that will be enforced on the `GenerateTextRequest.prompt` and
* `GenerateTextResponse.candidates`. There should not be more than one
* setting for each `SafetyCategory` type. The API will block any prompts and
* responses that fail to meet the thresholds set by these settings. This list
* overrides the default settings for each `SafetyCategory` specified in the
* safety_settings. If there is no `SafetySetting` for a given
* `SafetyCategory` provided in the list, the API will use the default safety
* setting for that category.
* @param {string[]} request.stopSequences
* The set of character sequences (up to 5) that will stop output generation.
* If specified, the API will stop at the first appearance of a stop
* sequence. The stop sequence will not be included as part of the response.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.GenerateTextResponse|GenerateTextResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta2/text_service.generate_text.js</caption>
* region_tag:generativelanguage_v1beta2_generated_TextService_GenerateText_async
*/
generateText(request?: protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta2.IGenerateTextResponse,
(protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest | undefined),
{} | undefined
]>;
generateText(request: protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta2.IGenerateTextResponse, protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest | null | undefined, {} | null | undefined>): void;
generateText(request: protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta2.IGenerateTextResponse, protos.google.ai.generativelanguage.v1beta2.IGenerateTextRequest | null | undefined, {} | null | undefined>): void;
/**
* Generates an embedding from the model given an input message.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.model
* Required. The model name to use with the format model=models/{model}.
* @param {string} request.text
* Required. The free-form input text that the model will turn into an
* embedding.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.ai.generativelanguage.v1beta2.EmbedTextResponse|EmbedTextResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta2/text_service.embed_text.js</caption>
* region_tag:generativelanguage_v1beta2_generated_TextService_EmbedText_async
*/
embedText(request?: protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta2.IEmbedTextResponse,
protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest | undefined,
{} | undefined
]>;
embedText(request: protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta2.IEmbedTextResponse, protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest | null | undefined, {} | null | undefined>): void;
embedText(request: protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta2.IEmbedTextResponse, protos.google.ai.generativelanguage.v1beta2.IEmbedTextRequest | null | undefined, {} | null | undefined>): void;
/**
* Return a fully-qualified model resource name string.
*
* @param {string} model
* @returns {string} Resource name string.
*/
modelPath(model: string): string;
/**
* Parse the model from Model resource.
*
* @param {string} modelName
* A fully-qualified path representing Model resource.
* @returns {string} A string representing the model.
*/
matchModelFromModelName(modelName: string): string | number;
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close(): Promise<void>;
}