# Google Developers Knowledge V1 Client - Class SearchDocumentChunksRequest (0.1.0) Reference documentation and code samples for the Google Developers Knowledge V1 Client class SearchDocumentChunksRequest. Request message for [DeveloperKnowledge.SearchDocumentChunks](https://docs.cloud.google.com/php/docs/reference/developers-knowledge/latest/V1.Client.DeveloperKnowledgeClient#_Google_Developers_Knowledge_V1_Client_DeveloperKnowledgeClient__searchDocumentChunks__). Generated from protobuf message `google.developers.knowledge.v1.SearchDocumentChunksRequest` ## Namespace Google \\ Developers \\ Knowledge \\ V1 ## Methods ### __construct Constructor. | **Parameters** || |---|---| | **Name** | **Description** | | `data` | `array` Optional. Data for populating the Message object. | | `↳ query` | `string` Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". | | `↳ page_size` | `int` 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 20; values above 20 will result in an INVALID_ARGUMENT error. | | `↳ page_token` | `string` Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. | | `↳ filter` | `string` Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at . While `SearchDocumentChunks` returns [DocumentChunk](https://docs.cloud.google.com/php/docs/reference/developers-knowledge/latest/V1.DocumentChunk)s, 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"`. 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. | ### getQuery Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". | **Returns** || |---|---| | **Type** | **Description** | | `string` | | ### setQuery Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". | **Parameter** || |---|---| | **Name** | **Description** | | `var` | `string` | | **Returns** || |---|---| | **Type** | **Description** | | `$this` | | ### 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 20; values above 20 will result in an INVALID_ARGUMENT error. | **Returns** || |---|---| | **Type** | **Description** | | `int` | | ### setPageSize 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 20; values above 20 will result in an INVALID_ARGUMENT error. | **Parameter** || |---|---| | **Name** | **Description** | | `var` | `int` | | **Returns** || |---|---| | **Type** | **Description** | | `$this` | | ### getPageToken Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. | **Returns** || |---|---| | **Type** | **Description** | | `string` | | ### setPageToken Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. | **Parameter** || |---|---| | **Name** | **Description** | | `var` | `string` | | **Returns** || |---|---| | **Type** | **Description** | | `$this` | | ### getFilter Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at . While `SearchDocumentChunks` returns [DocumentChunk](https://docs.cloud.google.com/php/docs/reference/developers-knowledge/latest/V1.DocumentChunk)s, 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"`. 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. | **Returns** || |---|---| | **Type** | **Description** | | `string` | | ### setFilter Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at . While `SearchDocumentChunks` returns [DocumentChunk](https://docs.cloud.google.com/php/docs/reference/developers-knowledge/latest/V1.DocumentChunk)s, 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"`. 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. | **Parameter** || |---|---| | **Name** | **Description** | | `var` | `string` | | **Returns** || |---|---| | **Type** | **Description** | | `$this` | |