Class protos.google.cloud.discoveryengine.v1alpha.ConversationalSearchService (2.2.0)

Represents a ConversationalSearchService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1alpha.ConversationalSearchService

Package

@google-cloud/discoveryengine

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ConversationalSearchService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

answerQuery(request, callback)

public answerQuery(request: google.cloud.discoveryengine.v1alpha.IAnswerQueryRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQueryCallback): void;

Calls AnswerQuery.

Parameters
Name Description
request IAnswerQueryRequest

AnswerQueryRequest message or plain object
callback AnswerQueryCallback

Node-style callback called with the error, if any, and AnswerQueryResponse
Returns
Type Description
void

answerQuery(request)

public answerQuery(request: google.cloud.discoveryengine.v1alpha.IAnswerQueryRequest): Promise<google.cloud.discoveryengine.v1alpha.AnswerQueryResponse>;

Calls AnswerQuery.

Parameter
Name Description
request IAnswerQueryRequest

AnswerQueryRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.AnswerQueryResponse>

Promise

converseConversation(request, callback)

public converseConversation(request: google.cloud.discoveryengine.v1alpha.IConverseConversationRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversationCallback): void;

Calls ConverseConversation.

Parameters
Name Description
request IConverseConversationRequest

ConverseConversationRequest message or plain object
callback ConverseConversationCallback

Node-style callback called with the error, if any, and ConverseConversationResponse
Returns
Type Description
void

converseConversation(request)

public converseConversation(request: google.cloud.discoveryengine.v1alpha.IConverseConversationRequest): Promise<google.cloud.discoveryengine.v1alpha.ConverseConversationResponse>;

Calls ConverseConversation.

Parameter
Name Description
request IConverseConversationRequest

ConverseConversationRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.ConverseConversationResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ConversationalSearchService;

Creates new ConversationalSearchService 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
ConversationalSearchService

RPC service. Useful where requests and/or responses are streamed.

createConversation(request, callback)

public createConversation(request: google.cloud.discoveryengine.v1alpha.ICreateConversationRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.CreateConversationCallback): void;

Calls CreateConversation.

Parameters
Name Description
request ICreateConversationRequest

CreateConversationRequest message or plain object
callback CreateConversationCallback

Node-style callback called with the error, if any, and Conversation
Returns
Type Description
void

createConversation(request)

public createConversation(request: google.cloud.discoveryengine.v1alpha.ICreateConversationRequest): Promise<google.cloud.discoveryengine.v1alpha.Conversation>;

Calls CreateConversation.

Parameter
Name Description
request ICreateConversationRequest

CreateConversationRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Conversation>

Promise

createSession(request, callback)

public createSession(request: google.cloud.discoveryengine.v1alpha.ICreateSessionRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.CreateSessionCallback): void;

Calls CreateSession.

Parameters
Name Description
request ICreateSessionRequest

CreateSessionRequest message or plain object
callback CreateSessionCallback

Node-style callback called with the error, if any, and Session
Returns
Type Description
void

createSession(request)

public createSession(request: google.cloud.discoveryengine.v1alpha.ICreateSessionRequest): Promise<google.cloud.discoveryengine.v1alpha.Session>;

Calls CreateSession.

Parameter
Name Description
request ICreateSessionRequest

CreateSessionRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Session>

Promise

deleteConversation(request, callback)

public deleteConversation(request: google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.DeleteConversationCallback): void;

Calls DeleteConversation.

Parameters
Name Description
request IDeleteConversationRequest

DeleteConversationRequest message or plain object
callback DeleteConversationCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteConversation(request)

public deleteConversation(request: google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest): Promise<google.protobuf.Empty>;

Calls DeleteConversation.

Parameter
Name Description
request IDeleteConversationRequest

DeleteConversationRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteSession(request, callback)

public deleteSession(request: google.cloud.discoveryengine.v1alpha.IDeleteSessionRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.DeleteSessionCallback): void;

Calls DeleteSession.

Parameters
Name Description
request IDeleteSessionRequest

DeleteSessionRequest message or plain object
callback DeleteSessionCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteSession(request)

public deleteSession(request: google.cloud.discoveryengine.v1alpha.IDeleteSessionRequest): Promise<google.protobuf.Empty>;

Calls DeleteSession.

Parameter
Name Description
request IDeleteSessionRequest

DeleteSessionRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getAnswer(request, callback)

public getAnswer(request: google.cloud.discoveryengine.v1alpha.IGetAnswerRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswerCallback): void;

Calls GetAnswer.

Parameters
Name Description
request IGetAnswerRequest

GetAnswerRequest message or plain object
callback GetAnswerCallback

Node-style callback called with the error, if any, and Answer
Returns
Type Description
void

getAnswer(request)

public getAnswer(request: google.cloud.discoveryengine.v1alpha.IGetAnswerRequest): Promise<google.cloud.discoveryengine.v1alpha.Answer>;

Calls GetAnswer.

Parameter
Name Description
request IGetAnswerRequest

GetAnswerRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Answer>

Promise

getConversation(request, callback)

public getConversation(request: google.cloud.discoveryengine.v1alpha.IGetConversationRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetConversationCallback): void;

Calls GetConversation.

Parameters
Name Description
request IGetConversationRequest

GetConversationRequest message or plain object
callback GetConversationCallback

Node-style callback called with the error, if any, and Conversation
Returns
Type Description
void

getConversation(request)

public getConversation(request: google.cloud.discoveryengine.v1alpha.IGetConversationRequest): Promise<google.cloud.discoveryengine.v1alpha.Conversation>;

Calls GetConversation.

Parameter
Name Description
request IGetConversationRequest

GetConversationRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Conversation>

Promise

getSession(request, callback)

public getSession(request: google.cloud.discoveryengine.v1alpha.IGetSessionRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSessionCallback): void;

Calls GetSession.

Parameters
Name Description
request IGetSessionRequest

GetSessionRequest message or plain object
callback GetSessionCallback

Node-style callback called with the error, if any, and Session
Returns
Type Description
void

getSession(request)

public getSession(request: google.cloud.discoveryengine.v1alpha.IGetSessionRequest): Promise<google.cloud.discoveryengine.v1alpha.Session>;

Calls GetSession.

Parameter
Name Description
request IGetSessionRequest

GetSessionRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Session>

Promise

listConversations(request, callback)

public listConversations(request: google.cloud.discoveryengine.v1alpha.IListConversationsRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ListConversationsCallback): void;

Calls ListConversations.

Parameters
Name Description
request IListConversationsRequest

ListConversationsRequest message or plain object
callback ListConversationsCallback

Node-style callback called with the error, if any, and ListConversationsResponse
Returns
Type Description
void

listConversations(request)

public listConversations(request: google.cloud.discoveryengine.v1alpha.IListConversationsRequest): Promise<google.cloud.discoveryengine.v1alpha.ListConversationsResponse>;

Calls ListConversations.

Parameter
Name Description
request IListConversationsRequest

ListConversationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.ListConversationsResponse>

Promise

listSessions(request, callback)

public listSessions(request: google.cloud.discoveryengine.v1alpha.IListSessionsRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ListSessionsCallback): void;

Calls ListSessions.

Parameters
Name Description
request IListSessionsRequest

ListSessionsRequest message or plain object
callback ListSessionsCallback

Node-style callback called with the error, if any, and ListSessionsResponse
Returns
Type Description
void

listSessions(request)

public listSessions(request: google.cloud.discoveryengine.v1alpha.IListSessionsRequest): Promise<google.cloud.discoveryengine.v1alpha.ListSessionsResponse>;

Calls ListSessions.

Parameter
Name Description
request IListSessionsRequest

ListSessionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.ListSessionsResponse>

Promise

updateConversation(request, callback)

public updateConversation(request: google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.UpdateConversationCallback): void;

Calls UpdateConversation.

Parameters
Name Description
request IUpdateConversationRequest

UpdateConversationRequest message or plain object
callback UpdateConversationCallback

Node-style callback called with the error, if any, and Conversation
Returns
Type Description
void

updateConversation(request)

public updateConversation(request: google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest): Promise<google.cloud.discoveryengine.v1alpha.Conversation>;

Calls UpdateConversation.

Parameter
Name Description
request IUpdateConversationRequest

UpdateConversationRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Conversation>

Promise

updateSession(request, callback)

public updateSession(request: google.cloud.discoveryengine.v1alpha.IUpdateSessionRequest, callback: google.cloud.discoveryengine.v1alpha.ConversationalSearchService.UpdateSessionCallback): void;

Calls UpdateSession.

Parameters
Name Description
request IUpdateSessionRequest

UpdateSessionRequest message or plain object
callback UpdateSessionCallback

Node-style callback called with the error, if any, and Session
Returns
Type Description
void

updateSession(request)

public updateSession(request: google.cloud.discoveryengine.v1alpha.IUpdateSessionRequest): Promise<google.cloud.discoveryengine.v1alpha.Session>;

Calls UpdateSession.

Parameter
Name Description
request IUpdateSessionRequest

UpdateSessionRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.Session>

Promise