Represents a RetrieverService
Inheritance
$protobuf.rpc.Service > protos.google.ai.generativelanguage.v1beta.RetrieverServicePackage
@google-ai/generativelanguageConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);Constructs a new RetrieverService service.
| Parameters | |
|---|---|
| Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Methods
batchCreateChunks(request, callback)
public batchCreateChunks(request: google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.BatchCreateChunksCallback): void;Calls BatchCreateChunks.
| Parameters | |
|---|---|
| Name | Description |
request |
IBatchCreateChunksRequest
BatchCreateChunksRequest message or plain object |
callback |
BatchCreateChunksCallback
Node-style callback called with the error, if any, and BatchCreateChunksResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
batchCreateChunks(request)
public batchCreateChunks(request: google.ai.generativelanguage.v1beta.IBatchCreateChunksRequest): Promise<google.ai.generativelanguage.v1beta.BatchCreateChunksResponse>;Calls BatchCreateChunks.
| Parameter | |
|---|---|
| Name | Description |
request |
IBatchCreateChunksRequest
BatchCreateChunksRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.BatchCreateChunksResponse> |
Promise |
batchDeleteChunks(request, callback)
public batchDeleteChunks(request: google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.BatchDeleteChunksCallback): void;Calls BatchDeleteChunks.
| Parameters | |
|---|---|
| Name | Description |
request |
IBatchDeleteChunksRequest
BatchDeleteChunksRequest message or plain object |
callback |
BatchDeleteChunksCallback
Node-style callback called with the error, if any, and Empty |
| Returns | |
|---|---|
| Type | Description |
void |
|
batchDeleteChunks(request)
public batchDeleteChunks(request: google.ai.generativelanguage.v1beta.IBatchDeleteChunksRequest): Promise<google.protobuf.Empty>;Calls BatchDeleteChunks.
| Parameter | |
|---|---|
| Name | Description |
request |
IBatchDeleteChunksRequest
BatchDeleteChunksRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.protobuf.Empty> |
Promise |
batchUpdateChunks(request, callback)
public batchUpdateChunks(request: google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.BatchUpdateChunksCallback): void;Calls BatchUpdateChunks.
| Parameters | |
|---|---|
| Name | Description |
request |
IBatchUpdateChunksRequest
BatchUpdateChunksRequest message or plain object |
callback |
BatchUpdateChunksCallback
Node-style callback called with the error, if any, and BatchUpdateChunksResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
batchUpdateChunks(request)
public batchUpdateChunks(request: google.ai.generativelanguage.v1beta.IBatchUpdateChunksRequest): Promise<google.ai.generativelanguage.v1beta.BatchUpdateChunksResponse>;Calls BatchUpdateChunks.
| Parameter | |
|---|---|
| Name | Description |
request |
IBatchUpdateChunksRequest
BatchUpdateChunksRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.BatchUpdateChunksResponse> |
Promise |
create(rpcImpl, requestDelimited, responseDelimited)
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RetrieverService;Creates new RetrieverService service using the specified rpc implementation.
| Parameters | |
|---|---|
| Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
| Returns | |
|---|---|
| Type | Description |
RetrieverService |
RPC service. Useful where requests and/or responses are streamed. |
createChunk(request, callback)
public createChunk(request: google.ai.generativelanguage.v1beta.ICreateChunkRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.CreateChunkCallback): void;Calls CreateChunk.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateChunkRequest
CreateChunkRequest message or plain object |
callback |
CreateChunkCallback
Node-style callback called with the error, if any, and Chunk |
| Returns | |
|---|---|
| Type | Description |
void |
|
createChunk(request)
public createChunk(request: google.ai.generativelanguage.v1beta.ICreateChunkRequest): Promise<google.ai.generativelanguage.v1beta.Chunk>;Calls CreateChunk.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateChunkRequest
CreateChunkRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Chunk> |
Promise |
createCorpus(request, callback)
public createCorpus(request: google.ai.generativelanguage.v1beta.ICreateCorpusRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.CreateCorpusCallback): void;Calls CreateCorpus.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateCorpusRequest
CreateCorpusRequest message or plain object |
callback |
CreateCorpusCallback
Node-style callback called with the error, if any, and Corpus |
| Returns | |
|---|---|
| Type | Description |
void |
|
createCorpus(request)
public createCorpus(request: google.ai.generativelanguage.v1beta.ICreateCorpusRequest): Promise<google.ai.generativelanguage.v1beta.Corpus>;Calls CreateCorpus.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateCorpusRequest
CreateCorpusRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Corpus> |
Promise |
createDocument(request, callback)
public createDocument(request: google.ai.generativelanguage.v1beta.ICreateDocumentRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.CreateDocumentCallback): void;Calls CreateDocument.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateDocumentRequest
CreateDocumentRequest message or plain object |
callback |
CreateDocumentCallback
Node-style callback called with the error, if any, and Document |
| Returns | |
|---|---|
| Type | Description |
void |
|
createDocument(request)
public createDocument(request: google.ai.generativelanguage.v1beta.ICreateDocumentRequest): Promise<google.ai.generativelanguage.v1beta.Document>;Calls CreateDocument.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateDocumentRequest
CreateDocumentRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Document> |
Promise |
deleteChunk(request, callback)
public deleteChunk(request: google.ai.generativelanguage.v1beta.IDeleteChunkRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.DeleteChunkCallback): void;Calls DeleteChunk.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteChunkRequest
DeleteChunkRequest message or plain object |
callback |
DeleteChunkCallback
Node-style callback called with the error, if any, and Empty |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteChunk(request)
public deleteChunk(request: google.ai.generativelanguage.v1beta.IDeleteChunkRequest): Promise<google.protobuf.Empty>;Calls DeleteChunk.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteChunkRequest
DeleteChunkRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.protobuf.Empty> |
Promise |
deleteCorpus(request, callback)
public deleteCorpus(request: google.ai.generativelanguage.v1beta.IDeleteCorpusRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.DeleteCorpusCallback): void;Calls DeleteCorpus.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteCorpusRequest
DeleteCorpusRequest message or plain object |
callback |
DeleteCorpusCallback
Node-style callback called with the error, if any, and Empty |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteCorpus(request)
public deleteCorpus(request: google.ai.generativelanguage.v1beta.IDeleteCorpusRequest): Promise<google.protobuf.Empty>;Calls DeleteCorpus.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteCorpusRequest
DeleteCorpusRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.protobuf.Empty> |
Promise |
deleteDocument(request, callback)
public deleteDocument(request: google.ai.generativelanguage.v1beta.IDeleteDocumentRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.DeleteDocumentCallback): void;Calls DeleteDocument.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteDocumentRequest
DeleteDocumentRequest message or plain object |
callback |
DeleteDocumentCallback
Node-style callback called with the error, if any, and Empty |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteDocument(request)
public deleteDocument(request: google.ai.generativelanguage.v1beta.IDeleteDocumentRequest): Promise<google.protobuf.Empty>;Calls DeleteDocument.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteDocumentRequest
DeleteDocumentRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.protobuf.Empty> |
Promise |
getChunk(request, callback)
public getChunk(request: google.ai.generativelanguage.v1beta.IGetChunkRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.GetChunkCallback): void;Calls GetChunk.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetChunkRequest
GetChunkRequest message or plain object |
callback |
GetChunkCallback
Node-style callback called with the error, if any, and Chunk |
| Returns | |
|---|---|
| Type | Description |
void |
|
getChunk(request)
public getChunk(request: google.ai.generativelanguage.v1beta.IGetChunkRequest): Promise<google.ai.generativelanguage.v1beta.Chunk>;Calls GetChunk.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetChunkRequest
GetChunkRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Chunk> |
Promise |
getCorpus(request, callback)
public getCorpus(request: google.ai.generativelanguage.v1beta.IGetCorpusRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.GetCorpusCallback): void;Calls GetCorpus.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetCorpusRequest
GetCorpusRequest message or plain object |
callback |
GetCorpusCallback
Node-style callback called with the error, if any, and Corpus |
| Returns | |
|---|---|
| Type | Description |
void |
|
getCorpus(request)
public getCorpus(request: google.ai.generativelanguage.v1beta.IGetCorpusRequest): Promise<google.ai.generativelanguage.v1beta.Corpus>;Calls GetCorpus.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetCorpusRequest
GetCorpusRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Corpus> |
Promise |
getDocument(request, callback)
public getDocument(request: google.ai.generativelanguage.v1beta.IGetDocumentRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.GetDocumentCallback): void;Calls GetDocument.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetDocumentRequest
GetDocumentRequest message or plain object |
callback |
GetDocumentCallback
Node-style callback called with the error, if any, and Document |
| Returns | |
|---|---|
| Type | Description |
void |
|
getDocument(request)
public getDocument(request: google.ai.generativelanguage.v1beta.IGetDocumentRequest): Promise<google.ai.generativelanguage.v1beta.Document>;Calls GetDocument.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetDocumentRequest
GetDocumentRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Document> |
Promise |
listChunks(request, callback)
public listChunks(request: google.ai.generativelanguage.v1beta.IListChunksRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.ListChunksCallback): void;Calls ListChunks.
| Parameters | |
|---|---|
| Name | Description |
request |
IListChunksRequest
ListChunksRequest message or plain object |
callback |
ListChunksCallback
Node-style callback called with the error, if any, and ListChunksResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listChunks(request)
public listChunks(request: google.ai.generativelanguage.v1beta.IListChunksRequest): Promise<google.ai.generativelanguage.v1beta.ListChunksResponse>;Calls ListChunks.
| Parameter | |
|---|---|
| Name | Description |
request |
IListChunksRequest
ListChunksRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.ListChunksResponse> |
Promise |
listCorpora(request, callback)
public listCorpora(request: google.ai.generativelanguage.v1beta.IListCorporaRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.ListCorporaCallback): void;Calls ListCorpora.
| Parameters | |
|---|---|
| Name | Description |
request |
IListCorporaRequest
ListCorporaRequest message or plain object |
callback |
ListCorporaCallback
Node-style callback called with the error, if any, and ListCorporaResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listCorpora(request)
public listCorpora(request: google.ai.generativelanguage.v1beta.IListCorporaRequest): Promise<google.ai.generativelanguage.v1beta.ListCorporaResponse>;Calls ListCorpora.
| Parameter | |
|---|---|
| Name | Description |
request |
IListCorporaRequest
ListCorporaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.ListCorporaResponse> |
Promise |
listDocuments(request, callback)
public listDocuments(request: google.ai.generativelanguage.v1beta.IListDocumentsRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.ListDocumentsCallback): void;Calls ListDocuments.
| Parameters | |
|---|---|
| Name | Description |
request |
IListDocumentsRequest
ListDocumentsRequest message or plain object |
callback |
ListDocumentsCallback
Node-style callback called with the error, if any, and ListDocumentsResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listDocuments(request)
public listDocuments(request: google.ai.generativelanguage.v1beta.IListDocumentsRequest): Promise<google.ai.generativelanguage.v1beta.ListDocumentsResponse>;Calls ListDocuments.
| Parameter | |
|---|---|
| Name | Description |
request |
IListDocumentsRequest
ListDocumentsRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.ListDocumentsResponse> |
Promise |
queryCorpus(request, callback)
public queryCorpus(request: google.ai.generativelanguage.v1beta.IQueryCorpusRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.QueryCorpusCallback): void;Calls QueryCorpus.
| Parameters | |
|---|---|
| Name | Description |
request |
IQueryCorpusRequest
QueryCorpusRequest message or plain object |
callback |
QueryCorpusCallback
Node-style callback called with the error, if any, and QueryCorpusResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
queryCorpus(request)
public queryCorpus(request: google.ai.generativelanguage.v1beta.IQueryCorpusRequest): Promise<google.ai.generativelanguage.v1beta.QueryCorpusResponse>;Calls QueryCorpus.
| Parameter | |
|---|---|
| Name | Description |
request |
IQueryCorpusRequest
QueryCorpusRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.QueryCorpusResponse> |
Promise |
queryDocument(request, callback)
public queryDocument(request: google.ai.generativelanguage.v1beta.IQueryDocumentRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.QueryDocumentCallback): void;Calls QueryDocument.
| Parameters | |
|---|---|
| Name | Description |
request |
IQueryDocumentRequest
QueryDocumentRequest message or plain object |
callback |
QueryDocumentCallback
Node-style callback called with the error, if any, and QueryDocumentResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
queryDocument(request)
public queryDocument(request: google.ai.generativelanguage.v1beta.IQueryDocumentRequest): Promise<google.ai.generativelanguage.v1beta.QueryDocumentResponse>;Calls QueryDocument.
| Parameter | |
|---|---|
| Name | Description |
request |
IQueryDocumentRequest
QueryDocumentRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.QueryDocumentResponse> |
Promise |
updateChunk(request, callback)
public updateChunk(request: google.ai.generativelanguage.v1beta.IUpdateChunkRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.UpdateChunkCallback): void;Calls UpdateChunk.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateChunkRequest
UpdateChunkRequest message or plain object |
callback |
UpdateChunkCallback
Node-style callback called with the error, if any, and Chunk |
| Returns | |
|---|---|
| Type | Description |
void |
|
updateChunk(request)
public updateChunk(request: google.ai.generativelanguage.v1beta.IUpdateChunkRequest): Promise<google.ai.generativelanguage.v1beta.Chunk>;Calls UpdateChunk.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateChunkRequest
UpdateChunkRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Chunk> |
Promise |
updateCorpus(request, callback)
public updateCorpus(request: google.ai.generativelanguage.v1beta.IUpdateCorpusRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.UpdateCorpusCallback): void;Calls UpdateCorpus.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateCorpusRequest
UpdateCorpusRequest message or plain object |
callback |
UpdateCorpusCallback
Node-style callback called with the error, if any, and Corpus |
| Returns | |
|---|---|
| Type | Description |
void |
|
updateCorpus(request)
public updateCorpus(request: google.ai.generativelanguage.v1beta.IUpdateCorpusRequest): Promise<google.ai.generativelanguage.v1beta.Corpus>;Calls UpdateCorpus.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateCorpusRequest
UpdateCorpusRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Corpus> |
Promise |
updateDocument(request, callback)
public updateDocument(request: google.ai.generativelanguage.v1beta.IUpdateDocumentRequest, callback: google.ai.generativelanguage.v1beta.RetrieverService.UpdateDocumentCallback): void;Calls UpdateDocument.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateDocumentRequest
UpdateDocumentRequest message or plain object |
callback |
UpdateDocumentCallback
Node-style callback called with the error, if any, and Document |
| Returns | |
|---|---|
| Type | Description |
void |
|
updateDocument(request)
public updateDocument(request: google.ai.generativelanguage.v1beta.IUpdateDocumentRequest): Promise<google.ai.generativelanguage.v1beta.Document>;Calls UpdateDocument.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateDocumentRequest
UpdateDocumentRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.ai.generativelanguage.v1beta.Document> |
Promise |