Class DocumentsResource.SearchDocumentChunksRequest

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchDocumentChunksResponse>
DeveloperKnowledgeBaseServiceRequest<SearchDocumentChunksResponse>
DocumentsResource.SearchDocumentChunksRequest
Implements
Inherited Members
Namespace: Google.Apis.DeveloperKnowledge.v1alpha
Assembly: Google.Apis.DeveloperKnowledge.v1alpha.dll
Syntax
public class DocumentsResource.SearchDocumentChunksRequest : DeveloperKnowledgeBaseServiceRequest<SearchDocumentChunksResponse>, IClientServiceRequest<SearchDocumentChunksResponse>, IClientServiceRequest

Constructors

SearchDocumentChunksRequest(IClientService)

Constructs a new SearchDocumentChunks request.

Declaration
public SearchDocumentChunksRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Filter

Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. 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 https://developers.google.com/knowledge/reference/corpus-reference 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 =, &lt;, &lt;=, &gt;, and &gt;= 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 &lt; "2024-01-01T00:00:00Z" * update_time &gt;= "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.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. Contains a page token, received from a previous SearchDocumentChunks call. Provide this to retrieve the subsequent page.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes SearchDocumentChunks parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements