public interface AssistQueryParametersOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsDocumentsMetadataFilters(String key)
public abstract boolean containsDocumentsMetadataFilters(String key) Key-value filters on the metadata of documents returned by article
suggestion. If specified, article suggestion only returns suggested
documents that match all filters in their
Document.metadata.
Multiple values for a metadata key should be concatenated by comma. For
example, filters to match all documents that have 'US' or 'CA' in their
market metadata values and 'agent' in their user metadata values will be
<code><code>
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
</code></code>
map<string, string> documents_metadata_filters = 1;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDocumentsMetadataFilters() (deprecated)
public abstract Map<String,String> getDocumentsMetadataFilters()Use #getDocumentsMetadataFiltersMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getDocumentsMetadataFiltersCount()
public abstract int getDocumentsMetadataFiltersCount() Key-value filters on the metadata of documents returned by article
suggestion. If specified, article suggestion only returns suggested
documents that match all filters in their
Document.metadata.
Multiple values for a metadata key should be concatenated by comma. For
example, filters to match all documents that have 'US' or 'CA' in their
market metadata values and 'agent' in their user metadata values will be
<code><code>
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
</code></code>
map<string, string> documents_metadata_filters = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
getDocumentsMetadataFiltersMap()
public abstract Map<String,String> getDocumentsMetadataFiltersMap() Key-value filters on the metadata of documents returned by article
suggestion. If specified, article suggestion only returns suggested
documents that match all filters in their
Document.metadata.
Multiple values for a metadata key should be concatenated by comma. For
example, filters to match all documents that have 'US' or 'CA' in their
market metadata values and 'agent' in their user metadata values will be
<code><code>
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
</code></code>
map<string, string> documents_metadata_filters = 1;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getDocumentsMetadataFiltersOrDefault(String key, String defaultValue)
public abstract String getDocumentsMetadataFiltersOrDefault(String key, String defaultValue) Key-value filters on the metadata of documents returned by article
suggestion. If specified, article suggestion only returns suggested
documents that match all filters in their
Document.metadata.
Multiple values for a metadata key should be concatenated by comma. For
example, filters to match all documents that have 'US' or 'CA' in their
market metadata values and 'agent' in their user metadata values will be
<code><code>
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
</code></code>
map<string, string> documents_metadata_filters = 1;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getDocumentsMetadataFiltersOrThrow(String key)
public abstract String getDocumentsMetadataFiltersOrThrow(String key) Key-value filters on the metadata of documents returned by article
suggestion. If specified, article suggestion only returns suggested
documents that match all filters in their
Document.metadata.
Multiple values for a metadata key should be concatenated by comma. For
example, filters to match all documents that have 'US' or 'CA' in their
market metadata values and 'agent' in their user metadata values will be
<code><code>
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
</code></code>
map<string, string> documents_metadata_filters = 1;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |