public static interface RecommendResponse.RecommendationResultOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMetadata(String key)
public abstract boolean containsMetadata(String key)Additional Document metadata or annotations.
Possible values:
score: Recommendation score in double value. Is set ifreturnScoreis set to true in RecommendRequest.params.
map<string, .google.protobuf.Value> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDocument()
public abstract Document getDocument() Set if returnDocument is set to true in
RecommendRequest.params.
.google.cloud.discoveryengine.v1beta.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
Document |
The document. |
getDocumentOrBuilder()
public abstract DocumentOrBuilder getDocumentOrBuilder() Set if returnDocument is set to true in
RecommendRequest.params.
.google.cloud.discoveryengine.v1beta.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
DocumentOrBuilder |
|
getId()
public abstract String getId()Resource ID of the recommended Document.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public abstract ByteString getIdBytes()Resource ID of the recommended Document.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getMetadata() (deprecated)
public abstract Map<String,Value> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getMetadataCount()
public abstract int getMetadataCount()Additional Document metadata or annotations.
Possible values:
score: Recommendation score in double value. Is set ifreturnScoreis set to true in RecommendRequest.params.
map<string, .google.protobuf.Value> metadata = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetadataMap()
public abstract Map<String,Value> getMetadataMap()Additional Document metadata or annotations.
Possible values:
score: Recommendation score in double value. Is set ifreturnScoreis set to true in RecommendRequest.params.
map<string, .google.protobuf.Value> metadata = 3;
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getMetadataOrDefault(String key, Value defaultValue)
public abstract Value getMetadataOrDefault(String key, Value defaultValue)Additional Document metadata or annotations.
Possible values:
score: Recommendation score in double value. Is set ifreturnScoreis set to true in RecommendRequest.params.
map<string, .google.protobuf.Value> metadata = 3;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
Value |
| Returns | |
|---|---|
| Type | Description |
Value |
|
getMetadataOrThrow(String key)
public abstract Value getMetadataOrThrow(String key)Additional Document metadata or annotations.
Possible values:
score: Recommendation score in double value. Is set ifreturnScoreis set to true in RecommendRequest.params.
map<string, .google.protobuf.Value> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Value |
|
hasDocument()
public abstract boolean hasDocument() Set if returnDocument is set to true in
RecommendRequest.params.
.google.cloud.discoveryengine.v1beta.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the document field is set. |