0.3.0 (latest) 0.2.0 0.1.0 public interface SearchDocumentChunksRequestOrBuilder extends MessageOrBuilder ## Implements com.google.protobuf.MessageOrBuilder ## Methods ### getFilter() public abstract String getFilter() Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at . While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: - `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See for the complete list of data sources in the corpus. - `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. - `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `"docs.cloud.google.com"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: - `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` - `data_source != "firebase.google.com"` - `update_time < "2024-01-01T00:00:00Z"` - `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` - `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error. `string filter = 4 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The filter. | ### getFilterBytes() public abstract ByteString getFilterBytes() Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at . While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: - `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See for the complete list of data sources in the corpus. - `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. - `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `"docs.cloud.google.com"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: - `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` - `data_source != "firebase.google.com"` - `update_time < "2024-01-01T00:00:00Z"` - `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` - `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error. `string filter = 4 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `com.google.protobuf.ByteString` | The bytes for filter. | ### getPageSize() public abstract int getPageSize() Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100. `int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The pageSize. | ### getPageToken() public abstract String getPageToken() Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. `string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The pageToken. | ### getPageTokenBytes() public abstract ByteString getPageTokenBytes() Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. `string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `com.google.protobuf.ByteString` | The bytes for pageToken. | ### getQuery() public abstract String getQuery() Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". `string query = 1 [(.google.api.field_behavior) = REQUIRED];` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The query. | ### getQueryBytes() public abstract ByteString getQueryBytes() Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". `string query = 1 [(.google.api.field_behavior) = REQUIRED];` | **Returns** || |---|---| | **Type** | **Description** | | `com.google.protobuf.ByteString` | The bytes for query. |