public interface StreamChatAiAssistantRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAttachOnly()
public abstract boolean getAttachOnly()Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.
bool attach_only = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The attachOnly. |
getAttachedGcsUris(int index)
public abstract String getAttachedGcsUris(int index)Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The attachedGcsUris at the given index. |
getAttachedGcsUrisBytes(int index)
public abstract ByteString getAttachedGcsUrisBytes(int index)Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the attachedGcsUris at the given index. |
getAttachedGcsUrisCount()
public abstract int getAttachedGcsUrisCount()Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of attachedGcsUris. |
getAttachedGcsUrisList()
public abstract List<String> getAttachedGcsUrisList()Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the attachedGcsUris. |
getClientCapabilities(int index)
public abstract StreamChatAiAssistantRequest.ClientCapability getClientCapabilities(int index) Optional. Response features this client can render. The server only emits
events that need a capability (e.g. confirmation_request) when the
capability is declared, so older clients never receive events they would
silently drop.
repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
StreamChatAiAssistantRequest.ClientCapability |
The clientCapabilities at the given index. |
getClientCapabilitiesCount()
public abstract int getClientCapabilitiesCount() Optional. Response features this client can render. The server only emits
events that need a capability (e.g. confirmation_request) when the
capability is declared, so older clients never receive events they would
silently drop.
repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of clientCapabilities. |
getClientCapabilitiesList()
public abstract List<StreamChatAiAssistantRequest.ClientCapability> getClientCapabilitiesList() Optional. Response features this client can render. The server only emits
events that need a capability (e.g. confirmation_request) when the
capability is declared, so older clients never receive events they would
silently drop.
repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<ClientCapability> |
A list containing the clientCapabilities. |
getClientCapabilitiesValue(int index)
public abstract int getClientCapabilitiesValue(int index) Optional. Response features this client can render. The server only emits
events that need a capability (e.g. confirmation_request) when the
capability is declared, so older clients never receive events they would
silently drop.
repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of clientCapabilities at the given index. |
getClientCapabilitiesValueList()
public abstract List<Integer> getClientCapabilitiesValueList() Optional. Response features this client can render. The server only emits
events that need a capability (e.g. confirmation_request) when the
capability is declared, so older clients never receive events they would
silently drop.
repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for clientCapabilities. |
getConfirmationResponse()
public abstract AssistantConfirmationResponse getConfirmationResponse()Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AssistantConfirmationResponse |
The confirmationResponse. |
getConfirmationResponseOrBuilder()
public abstract AssistantConfirmationResponseOrBuilder getConfirmationResponseOrBuilder()Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AssistantConfirmationResponseOrBuilder |
|
getContextToken()
public abstract String getContextToken()Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.
string context_token = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The contextToken. |
getContextTokenBytes()
public abstract ByteString getContextTokenBytes()Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.
string context_token = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for contextToken. |
getMessage()
public abstract String getMessage() Optional. The message to send to the assistant agent. May be empty when
confirmation_response is set (answering a pending confirmation without
adding a new message); at least one of the two must be provided.
string message = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The message. |
getMessageBytes()
public abstract ByteString getMessageBytes() Optional. The message to send to the assistant agent. May be empty when
confirmation_response is set (answering a pending confirmation without
adding a new message); at least one of the two must be provided.
string message = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for message. |
getName()
public abstract String getName() Required. The assistant session to be used to run the assistant.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Required. The assistant session to be used to run the assistant.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOperationCompletedEvent()
public abstract OperationCompletedEvent getOperationCompletedEvent()Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OperationCompletedEvent |
The operationCompletedEvent. |
getOperationCompletedEventOrBuilder()
public abstract OperationCompletedEventOrBuilder getOperationCompletedEventOrBuilder()Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OperationCompletedEventOrBuilder |
|
getResumeFromSequenceNumber()
public abstract long getResumeFromSequenceNumber()Optional. Optional cursor to resume and replay events from an in-flight or completed turn.
int64 resume_from_sequence_number = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The resumeFromSequenceNumber. |
hasConfirmationResponse()
public abstract boolean hasConfirmationResponse()Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the confirmationResponse field is set. |
hasOperationCompletedEvent()
public abstract boolean hasOperationCompletedEvent()Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the operationCompletedEvent field is set. |