An API for semantic search over a corpus of user uploaded content. v1beta
Package
@google-ai/generativelanguage
Constructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of RetrieverServiceClient.
| Parameters |
| Name |
Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: 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 RetrieverServiceClient({fallback: true}, gax); ```
|
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
retrieverServiceStub
retrieverServiceStub?: Promise<{
[name: string]: Function;
}>;
scopes
static get scopes(): never[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
batchCreateChunks(request, options)
batchCreateChunks(request?: protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksResponse,
(protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The name of the `Document` where this batch of `Chunk`s will be
* created. The parent field in every `CreateChunkRequest` must match this
* value. Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const parent = 'abc123'
/**
* Required. The request messages specifying the `Chunk`s to create.
* A maximum of 100 `Chunk`s can be created in a batch.
*/
// const requests = [1,2,3,4]
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callBatchCreateChunks() {
// Construct request
const request = {
requests,
};
// Run request
const response = await generativelanguageClient.batchCreateChunks(request);
console.log(response);
}
callBatchCreateChunks();
batchCreateChunks(request, options, callback)
batchCreateChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksResponse, protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
batchCreateChunks(request, callback)
batchCreateChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksResponse, protos.google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
batchDeleteChunks(request, options)
batchDeleteChunks(request?: protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The name of the `Document` containing the `Chunk`s to delete.
* The parent field in every `DeleteChunkRequest` must match this value.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const parent = 'abc123'
/**
* Required. The request messages specifying the `Chunk`s to delete.
*/
// const requests = [1,2,3,4]
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callBatchDeleteChunks() {
// Construct request
const request = {
requests,
};
// Run request
const response = await generativelanguageClient.batchDeleteChunks(request);
console.log(response);
}
callBatchDeleteChunks();
batchDeleteChunks(request, options, callback)
batchDeleteChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
batchDeleteChunks(request, callback)
batchDeleteChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
batchUpdateChunks(request, options)
batchUpdateChunks(request?: protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksResponse,
(protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The name of the `Document` containing the `Chunk`s to update.
* The parent field in every `UpdateChunkRequest` must match this value.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const parent = 'abc123'
/**
* Required. The request messages specifying the `Chunk`s to update.
* A maximum of 100 `Chunk`s can be updated in a batch.
*/
// const requests = [1,2,3,4]
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callBatchUpdateChunks() {
// Construct request
const request = {
requests,
};
// Run request
const response = await generativelanguageClient.batchUpdateChunks(request);
console.log(response);
}
callBatchUpdateChunks();
batchUpdateChunks(request, options, callback)
batchUpdateChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksResponse, protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
batchUpdateChunks(request, callback)
batchUpdateChunks(request: protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksResponse, protos.google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cachedContentPath(id)
cachedContentPath(id: string): string;
Return a fully-qualified cachedContent resource name string.
| Parameter |
| Name |
Description |
id |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
chunkPath(corpus, document, chunk)
chunkPath(corpus: string, document: string, chunk: string): string;
Return a fully-qualified chunk resource name string.
| Parameters |
| Name |
Description |
corpus |
string
|
document |
string
|
chunk |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns |
| Type |
Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed.
|
corpusPath(corpus)
corpusPath(corpus: string): string;
Return a fully-qualified corpus resource name string.
| Parameter |
| Name |
Description |
corpus |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
corpusPermissionPath(corpus, permission)
corpusPermissionPath(corpus: string, permission: string): string;
Return a fully-qualified corpusPermission resource name string.
| Parameters |
| Name |
Description |
corpus |
string
|
permission |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
createChunk(request, options)
createChunk(request?: protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IChunk,
(protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
ICreateChunkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Document` where this `Chunk` will be created.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const parent = 'abc123'
/**
* Required. The `Chunk` to create.
*/
// const chunk = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callCreateChunk() {
// Construct request
const request = {
parent,
chunk,
};
// Run request
const response = await generativelanguageClient.createChunk(request);
console.log(response);
}
callCreateChunk();
createChunk(request, options, callback)
createChunk(request: protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createChunk(request, callback)
createChunk(request: protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.ICreateChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createCorpus(request, options)
createCorpus(request?: protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.ICorpus,
(protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
ICreateCorpusRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The `Corpus` to create.
*/
// const corpus = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callCreateCorpus() {
// Construct request
const request = {
corpus,
};
// Run request
const response = await generativelanguageClient.createCorpus(request);
console.log(response);
}
callCreateCorpus();
createCorpus(request, options, callback)
createCorpus(request: protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createCorpus(request, callback)
createCorpus(request: protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.ICreateCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createDocument(request, options)
createDocument(request?: protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IDocument,
(protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest | undefined),
{} | undefined
]>;
Creates an empty Document.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Corpus` where this `Document` will be created.
* Example: `corpora/my-corpus-123`
*/
// const parent = 'abc123'
/**
* Required. The `Document` to create.
*/
// const document = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callCreateDocument() {
// Construct request
const request = {
parent,
document,
};
// Run request
const response = await generativelanguageClient.createDocument(request);
console.log(response);
}
callCreateDocument();
createDocument(request, options, callback)
createDocument(request: protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createDocument(request, callback)
createDocument(request: protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteChunk(request, options)
deleteChunk(request?: protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
IDeleteChunkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the `Chunk` to delete.
* Example: `corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk`
*/
// const name = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callDeleteChunk() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.deleteChunk(request);
console.log(response);
}
callDeleteChunk();
deleteChunk(request, options, callback)
deleteChunk(request: protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteChunk(request, callback)
deleteChunk(request: protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteCorpus(request, options)
deleteCorpus(request?: protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
IDeleteCorpusRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the `Corpus`.
* Example: `corpora/my-corpus-123`
*/
// const name = 'abc123'
/**
* Optional. If set to true, any `Document`s and objects related to this
* `Corpus` will also be deleted.
* If false (the default), a `FAILED_PRECONDITION` error will be returned if
* `Corpus` contains any `Document`s.
*/
// const force = true
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callDeleteCorpus() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.deleteCorpus(request);
console.log(response);
}
callDeleteCorpus();
deleteCorpus(request, options, callback)
deleteCorpus(request: protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteCorpus(request, callback)
deleteCorpus(request: protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteDocument(request, options)
deleteDocument(request?: protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the `Document` to delete.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const name = 'abc123'
/**
* Optional. If set to true, any `Chunk`s and objects related to this
* `Document` will also be deleted.
* If false (the default), a `FAILED_PRECONDITION` error will be returned if
* `Document` contains any `Chunk`s.
*/
// const force = true
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callDeleteDocument() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.deleteDocument(request);
console.log(response);
}
callDeleteDocument();
deleteDocument(request, options, callback)
deleteDocument(request: protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteDocument(request, callback)
deleteDocument(request: protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ai.generativelanguage.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
documentPath(corpus, document)
documentPath(corpus: string, document: string): string;
Return a fully-qualified document resource name string.
| Parameters |
| Name |
Description |
corpus |
string
|
document |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
filePath(file)
filePath(file: string): string;
Return a fully-qualified file resource name string.
| Parameter |
| Name |
Description |
file |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
getChunk(request, options)
getChunk(request?: protos.google.ai.generativelanguage.v1beta.IGetChunkRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IChunk,
protos.google.ai.generativelanguage.v1beta.IGetChunkRequest | undefined,
{} | undefined
]>;
Gets information about a specific Chunk.
| Parameters |
| Name |
Description |
request |
IGetChunkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Chunk` to retrieve.
* Example: `corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk`
*/
// const name = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callGetChunk() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.getChunk(request);
console.log(response);
}
callGetChunk();
getChunk(request, options, callback)
getChunk(request: protos.google.ai.generativelanguage.v1beta.IGetChunkRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.IGetChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getChunk(request, callback)
getChunk(request: protos.google.ai.generativelanguage.v1beta.IGetChunkRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.IGetChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getCorpus(request, options)
getCorpus(request?: protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.ICorpus,
protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest | undefined,
{} | undefined
]>;
Gets information about a specific Corpus.
| Parameters |
| Name |
Description |
request |
IGetCorpusRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Corpus`.
* Example: `corpora/my-corpus-123`
*/
// const name = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callGetCorpus() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.getCorpus(request);
console.log(response);
}
callGetCorpus();
getCorpus(request, options, callback)
getCorpus(request: protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getCorpus(request, callback)
getCorpus(request: protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.IGetCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getDocument(request, options)
getDocument(request?: protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IDocument,
(protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest | undefined),
{} | undefined
]>;
Gets information about a specific Document.
| Parameters |
| Name |
Description |
request |
IGetDocumentRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Document` to retrieve.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const name = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callGetDocument() {
// Construct request
const request = {
name,
};
// Run request
const response = await generativelanguageClient.getDocument(request);
console.log(response);
}
callGetDocument();
getDocument(request, options, callback)
getDocument(request: protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getDocument(request, callback)
getDocument(request: protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getProjectId()
getProjectId(): Promise<string>;
| Returns |
| Type |
Description |
Promise<string> |
|
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
| Parameter |
| Name |
Description |
callback |
Callback<string, undefined, undefined>
|
| Returns |
| Type |
Description |
void |
|
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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 |
| Type |
Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub.
|
listChunks(request, options)
listChunks(request?: protos.google.ai.generativelanguage.v1beta.IListChunksRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IChunk[],
protos.google.ai.generativelanguage.v1beta.IListChunksRequest | null,
protos.google.ai.generativelanguage.v1beta.IListChunksResponse
]>;
Lists all Chunks in a Document.
| Parameters |
| Name |
Description |
request |
IListChunksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
listChunks(request, options, callback)
listChunks(request: protos.google.ai.generativelanguage.v1beta.IListChunksRequest, options: CallOptions, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListChunksRequest, protos.google.ai.generativelanguage.v1beta.IListChunksResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.IChunk>): void;
| Returns |
| Type |
Description |
void |
|
listChunks(request, callback)
listChunks(request: protos.google.ai.generativelanguage.v1beta.IListChunksRequest, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListChunksRequest, protos.google.ai.generativelanguage.v1beta.IListChunksResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.IChunk>): void;
| Returns |
| Type |
Description |
void |
|
listChunksAsync(request, options)
listChunksAsync(request?: protos.google.ai.generativelanguage.v1beta.IListChunksRequest, options?: CallOptions): AsyncIterable<protos.google.ai.generativelanguage.v1beta.IChunk>;
Equivalent to listChunks, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters |
| Name |
Description |
request |
IListChunksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
| Returns |
| Type |
Description |
AsyncIterable<protos.google.ai.generativelanguage.v1beta.IChunk> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Document` containing `Chunk`s.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Chunk`s to return (per page).
* The service may return fewer `Chunk`s.
* If unspecified, at most 10 `Chunk`s will be returned.
* The maximum size limit is 100 `Chunk`s per page.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListChunks` call.
* Provide the `next_page_token` returned in the response as an argument to
* the next request to retrieve the next page.
* When paginating, all other parameters provided to `ListChunks`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callListChunks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = generativelanguageClient.listChunksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListChunks();
listChunksStream(request, options)
listChunksStream(request?: protos.google.ai.generativelanguage.v1beta.IListChunksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters |
| Name |
Description |
request |
IListChunksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
| Returns |
| Type |
Description |
Transform |
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listChunksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listCorpora(request, options)
listCorpora(request?: protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.ICorpus[],
protos.google.ai.generativelanguage.v1beta.IListCorporaRequest | null,
protos.google.ai.generativelanguage.v1beta.IListCorporaResponse
]>;
Lists all Corpora owned by the user.
| Parameters |
| Name |
Description |
request |
IListCorporaRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
listCorpora(request, options, callback)
listCorpora(request: protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, options: CallOptions, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, protos.google.ai.generativelanguage.v1beta.IListCorporaResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.ICorpus>): void;
| Returns |
| Type |
Description |
void |
|
listCorpora(request, callback)
listCorpora(request: protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, protos.google.ai.generativelanguage.v1beta.IListCorporaResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.ICorpus>): void;
| Returns |
| Type |
Description |
void |
|
listCorporaAsync(request, options)
listCorporaAsync(request?: protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, options?: CallOptions): AsyncIterable<protos.google.ai.generativelanguage.v1beta.ICorpus>;
Equivalent to listCorpora, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters |
| Name |
Description |
request |
IListCorporaRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
| Returns |
| Type |
Description |
AsyncIterable<protos.google.ai.generativelanguage.v1beta.ICorpus> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Corpus. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The maximum number of `Corpora` to return (per page).
* The service may return fewer `Corpora`.
* If unspecified, at most 10 `Corpora` will be returned.
* The maximum size limit is 20 `Corpora` per page.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListCorpora` call.
* Provide the `next_page_token` returned in the response as an argument to
* the next request to retrieve the next page.
* When paginating, all other parameters provided to `ListCorpora`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callListCorpora() {
// Construct request
const request = {
};
// Run request
const iterable = generativelanguageClient.listCorporaAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCorpora();
listCorporaStream(request, options)
listCorporaStream(request?: protos.google.ai.generativelanguage.v1beta.IListCorporaRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters |
| Name |
Description |
request |
IListCorporaRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
| Returns |
| Type |
Description |
Transform |
{Stream} An object stream which emits an object representing Corpus on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCorporaAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listDocuments(request, options)
listDocuments(request?: protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IDocument[],
protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest | null,
protos.google.ai.generativelanguage.v1beta.IListDocumentsResponse
]>;
Lists all Documents in a Corpus.
| Parameters |
| Name |
Description |
request |
IListDocumentsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
listDocuments(request, options, callback)
listDocuments(request: protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, protos.google.ai.generativelanguage.v1beta.IListDocumentsResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.IDocument>): void;
| Returns |
| Type |
Description |
void |
|
listDocuments(request, callback)
listDocuments(request: protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, callback: PaginationCallback<protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, protos.google.ai.generativelanguage.v1beta.IListDocumentsResponse | null | undefined, protos.google.ai.generativelanguage.v1beta.IDocument>): void;
| Returns |
| Type |
Description |
void |
|
listDocumentsAsync(request, options)
listDocumentsAsync(request?: protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.ai.generativelanguage.v1beta.IDocument>;
Equivalent to listDocuments, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters |
| Name |
Description |
request |
IListDocumentsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Corpus` containing `Document`s.
* Example: `corpora/my-corpus-123`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Document`s to return (per page).
* The service may return fewer `Document`s.
* If unspecified, at most 10 `Document`s will be returned.
* The maximum size limit is 20 `Document`s per page.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListDocuments` call.
* Provide the `next_page_token` returned in the response as an argument to
* the next request to retrieve the next page.
* When paginating, all other parameters provided to `ListDocuments`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callListDocuments() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = generativelanguageClient.listDocumentsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDocuments();
listDocumentsStream(request, options)
listDocumentsStream(request?: protos.google.ai.generativelanguage.v1beta.IListDocumentsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters |
| Name |
Description |
request |
IListDocumentsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
| Returns |
| Type |
Description |
Transform |
{Stream} An object stream which emits an object representing Document on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDocumentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
matchChunkFromChunkName(chunkName)
matchChunkFromChunkName(chunkName: string): string | number;
Parse the chunk from Chunk resource.
| Parameter |
| Name |
Description |
chunkName |
string
A fully-qualified path representing Chunk resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the chunk.
|
matchCorpusFromChunkName(chunkName)
matchCorpusFromChunkName(chunkName: string): string | number;
Parse the corpus from Chunk resource.
| Parameter |
| Name |
Description |
chunkName |
string
A fully-qualified path representing Chunk resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the corpus.
|
matchCorpusFromCorpusName(corpusName)
matchCorpusFromCorpusName(corpusName: string): string | number;
Parse the corpus from Corpus resource.
| Parameter |
| Name |
Description |
corpusName |
string
A fully-qualified path representing Corpus resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the corpus.
|
matchCorpusFromCorpusPermissionName(corpusPermissionName)
matchCorpusFromCorpusPermissionName(corpusPermissionName: string): string | number;
Parse the corpus from CorpusPermission resource.
| Parameter |
| Name |
Description |
corpusPermissionName |
string
A fully-qualified path representing corpus_permission resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the corpus.
|
matchCorpusFromDocumentName(documentName)
matchCorpusFromDocumentName(documentName: string): string | number;
Parse the corpus from Document resource.
| Parameter |
| Name |
Description |
documentName |
string
A fully-qualified path representing Document resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the corpus.
|
matchDocumentFromChunkName(chunkName)
matchDocumentFromChunkName(chunkName: string): string | number;
Parse the document from Chunk resource.
| Parameter |
| Name |
Description |
chunkName |
string
A fully-qualified path representing Chunk resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the document.
|
matchDocumentFromDocumentName(documentName)
matchDocumentFromDocumentName(documentName: string): string | number;
Parse the document from Document resource.
| Parameter |
| Name |
Description |
documentName |
string
A fully-qualified path representing Document resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the document.
|
matchFileFromFileName(fileName)
matchFileFromFileName(fileName: string): string | number;
Parse the file from File resource.
| Parameter |
| Name |
Description |
fileName |
string
A fully-qualified path representing File resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the file.
|
matchIdFromCachedContentName(cachedContentName)
matchIdFromCachedContentName(cachedContentName: string): string | number;
Parse the id from CachedContent resource.
| Parameter |
| Name |
Description |
cachedContentName |
string
A fully-qualified path representing CachedContent resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the id.
|
matchModelFromModelName(modelName)
matchModelFromModelName(modelName: string): string | number;
Parse the model from Model resource.
| Parameter |
| Name |
Description |
modelName |
string
A fully-qualified path representing Model resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the model.
|
matchPermissionFromCorpusPermissionName(corpusPermissionName)
matchPermissionFromCorpusPermissionName(corpusPermissionName: string): string | number;
Parse the permission from CorpusPermission resource.
| Parameter |
| Name |
Description |
corpusPermissionName |
string
A fully-qualified path representing corpus_permission resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the permission.
|
matchPermissionFromTunedModelPermissionName(tunedModelPermissionName)
matchPermissionFromTunedModelPermissionName(tunedModelPermissionName: string): string | number;
Parse the permission from TunedModelPermission resource.
| Parameter |
| Name |
Description |
tunedModelPermissionName |
string
A fully-qualified path representing tuned_model_permission resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the permission.
|
matchTunedModelFromTunedModelName(tunedModelName)
matchTunedModelFromTunedModelName(tunedModelName: string): string | number;
Parse the tuned_model from TunedModel resource.
| Parameter |
| Name |
Description |
tunedModelName |
string
A fully-qualified path representing TunedModel resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the tuned_model.
|
matchTunedModelFromTunedModelPermissionName(tunedModelPermissionName)
matchTunedModelFromTunedModelPermissionName(tunedModelPermissionName: string): string | number;
Parse the tuned_model from TunedModelPermission resource.
| Parameter |
| Name |
Description |
tunedModelPermissionName |
string
A fully-qualified path representing tuned_model_permission resource.
|
| Returns |
| Type |
Description |
string | number |
{string} A string representing the tuned_model.
|
modelPath(model)
modelPath(model: string): string;
Return a fully-qualified model resource name string.
| Parameter |
| Name |
Description |
model |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
queryCorpus(request, options)
queryCorpus(request?: protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IQueryCorpusResponse,
(protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest | undefined),
{} | undefined
]>;
Performs semantic search over a Corpus.
| Parameters |
| Name |
Description |
request |
IQueryCorpusRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Corpus` to query.
* Example: `corpora/my-corpus-123`
*/
// const name = 'abc123'
/**
* Required. Query string to perform semantic search.
*/
// const query = 'abc123'
/**
* Optional. Filter for `Chunk` and `Document` metadata. Each `MetadataFilter`
* object should correspond to a unique key. Multiple `MetadataFilter` objects
* are joined by logical "AND"s.
* Example query at document level:
* (year >= 2020 OR year < 2010)="" and="" (genre="drama" or="" genre="action)" *="" `metadatafilter`="" object="" list:="" *="" metadata_filters="*" {key="document.custom_metadata.year" *="" conditions="{int_value" =="" 2020,="" operation="GREATER_EQUAL}," *="" {int_value="2010," operation="LESS}" },="" *="" {key="document.custom_metadata.year" *="" conditions="{int_value" =="" 2020,="" operation="GREATER_EQUAL}," *="" {int_value="2010," operation="LESS}" },="" *="" {key="document.custom_metadata.genre" *="" conditions="{string_value" =="" "drama",="" operation="EQUAL}," *="" {string_value="action" ,="" operation="EQUAL}" }="" *="" example="" query="" at="" chunk="" level="" for="" a="" numeric="" range="" of="" values:="" *="" (year=""> 2015 AND year <= 2020)="" *="" `metadatafilter`="" object="" list:="" *="" metadata_filters="*" {key="chunk.custom_metadata.year" *="" conditions="{int_value" =="" 2015,="" operation="GREATER}" },="" *="" {key="chunk.custom_metadata.year" *="" conditions="{int_value" =="" 2020,="" operation="LESS_EQUAL}" }="" *="" note:="" "and"s="" for="" the="" same="" key="" are="" only="" supported="" for="" numeric="" values.="" string="" *="" values="" only="" support="" "or"s="" for="" the="" same="" key.="" */="" const="" metadatafilters="[1,2,3,4]" *="" *="" optional.="" the="" maximum="" number="" of="" `chunk`s="" to="" return.="" *="" the="" service="" may="" return="" fewer="" `chunk`s.="" *="" if="" unspecified,="" at="" most="" 10="" `chunk`s="" will="" be="" returned.="" *="" the="" maximum="" specified="" result="" count="" is="" 100.="" */="" const="" resultscount="1234" imports="" the="" generativelanguage="" library="" const="" {retrieverserviceclient}="require('@google-ai/generativelanguage').v1beta;" instantiates="" a="" client="" const="" generativelanguageclient="new" retrieverserviceclient();="" async="" function="" callquerycorpus()="" {="" construct="" request="" const="" request="{" name,="" query,="" };="" run="" request="" const="" response="await" generativelanguageclient.querycorpus(request);="" console.log(response);="" }="" callquerycorpus();="">
queryCorpus(request, options, callback)
queryCorpus(request: protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IQueryCorpusResponse, protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
queryCorpus(request, callback)
queryCorpus(request: protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IQueryCorpusResponse, protos.google.ai.generativelanguage.v1beta.IQueryCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
queryDocument(request, options)
queryDocument(request?: protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IQueryDocumentResponse,
(protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest | undefined),
{} | undefined
]>;
Performs semantic search over a Document.
| Parameters |
| Name |
Description |
request |
IQueryDocumentRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the `Document` to query.
* Example: `corpora/my-corpus-123/documents/the-doc-abc`
*/
// const name = 'abc123'
/**
* Required. Query string to perform semantic search.
*/
// const query = 'abc123'
/**
* Optional. The maximum number of `Chunk`s to return.
* The service may return fewer `Chunk`s.
* If unspecified, at most 10 `Chunk`s will be returned.
* The maximum specified result count is 100.
*/
// const resultsCount = 1234
/**
* Optional. Filter for `Chunk` metadata. Each `MetadataFilter` object should
* correspond to a unique key. Multiple `MetadataFilter` objects are joined by
* logical "AND"s.
* Note: `Document`-level filtering is not supported for this request because
* a `Document` name is already specified.
* Example query:
* (year >= 2020 OR year < 2010)="" and="" (genre="drama" or="" genre="action)" *="" `metadatafilter`="" object="" list:="" *="" metadata_filters="*" {key="chunk.custom_metadata.year" *="" conditions="{int_value" =="" 2020,="" operation="GREATER_EQUAL}," *="" {int_value="2010," operation="LESS}}," *="" {key="chunk.custom_metadata.genre" *="" conditions="{string_value" =="" "drama",="" operation="EQUAL}," *="" {string_value="action" ,="" operation="EQUAL}}" *="" example="" query="" for="" a="" numeric="" range="" of="" values:="" *="" (year=""> 2015 AND year <= 2020)="" *="" `metadatafilter`="" object="" list:="" *="" metadata_filters="*" {key="chunk.custom_metadata.year" *="" conditions="{int_value" =="" 2015,="" operation="GREATER}" },="" *="" {key="chunk.custom_metadata.year" *="" conditions="{int_value" =="" 2020,="" operation="LESS_EQUAL}" }="" *="" note:="" "and"s="" for="" the="" same="" key="" are="" only="" supported="" for="" numeric="" values.="" string="" *="" values="" only="" support="" "or"s="" for="" the="" same="" key.="" */="" const="" metadatafilters="[1,2,3,4]" imports="" the="" generativelanguage="" library="" const="" {retrieverserviceclient}="require('@google-ai/generativelanguage').v1beta;" instantiates="" a="" client="" const="" generativelanguageclient="new" retrieverserviceclient();="" async="" function="" callquerydocument()="" {="" construct="" request="" const="" request="{" name,="" query,="" };="" run="" request="" const="" response="await" generativelanguageclient.querydocument(request);="" console.log(response);="" }="" callquerydocument();="">
queryDocument(request, options, callback)
queryDocument(request: protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IQueryDocumentResponse, protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
queryDocument(request, callback)
queryDocument(request: protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IQueryDocumentResponse, protos.google.ai.generativelanguage.v1beta.IQueryDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
tunedModelPath(tunedModel)
tunedModelPath(tunedModel: string): string;
Return a fully-qualified tunedModel resource name string.
| Parameter |
| Name |
Description |
tunedModel |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
tunedModelPermissionPath(tunedModel, permission)
tunedModelPermissionPath(tunedModel: string, permission: string): string;
Return a fully-qualified tunedModelPermission resource name string.
| Parameters |
| Name |
Description |
tunedModel |
string
|
permission |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
updateChunk(request, options)
updateChunk(request?: protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IChunk,
(protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
IUpdateChunkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The `Chunk` to update.
*/
// const chunk = {}
/**
* Required. The list of fields to update.
* Currently, this only supports updating `custom_metadata` and `data`.
*/
// const updateMask = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callUpdateChunk() {
// Construct request
const request = {
chunk,
updateMask,
};
// Run request
const response = await generativelanguageClient.updateChunk(request);
console.log(response);
}
callUpdateChunk();
updateChunk(request, options, callback)
updateChunk(request: protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
updateChunk(request, callback)
updateChunk(request: protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IChunk, protos.google.ai.generativelanguage.v1beta.IUpdateChunkRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
updateCorpus(request, options)
updateCorpus(request?: protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.ICorpus,
(protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest | undefined),
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
IUpdateCorpusRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The `Corpus` to update.
*/
// const corpus = {}
/**
* Required. The list of fields to update.
* Currently, this only supports updating `display_name`.
*/
// const updateMask = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callUpdateCorpus() {
// Construct request
const request = {
corpus,
updateMask,
};
// Run request
const response = await generativelanguageClient.updateCorpus(request);
console.log(response);
}
callUpdateCorpus();
updateCorpus(request, options, callback)
updateCorpus(request: protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
updateCorpus(request, callback)
updateCorpus(request: protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.ICorpus, protos.google.ai.generativelanguage.v1beta.IUpdateCorpusRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
updateDocument(request, options)
updateDocument(request?: protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest, options?: CallOptions): Promise<[
protos.google.ai.generativelanguage.v1beta.IDocument,
(protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The `Document` to update.
*/
// const document = {}
/**
* Required. The list of fields to update.
* Currently, this only supports updating `display_name` and
* `custom_metadata`.
*/
// const updateMask = {}
// Imports the Generativelanguage library
const {RetrieverServiceClient} = require('@google-ai/generativelanguage').v1beta;
// Instantiates a client
const generativelanguageClient = new RetrieverServiceClient();
async function callUpdateDocument() {
// Construct request
const request = {
document,
updateMask,
};
// Run request
const response = await generativelanguageClient.updateDocument(request);
console.log(response);
}
callUpdateDocument();
updateDocument(request, options, callback)
updateDocument(request: protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
updateDocument(request, callback)
updateDocument(request: protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest, callback: Callback<protos.google.ai.generativelanguage.v1beta.IDocument, protos.google.ai.generativelanguage.v1beta.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
