Table of Contents

Class QueryDocumentRequest

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

Request body for performing semantic search over a Document.

public class QueryDocumentRequest
Inheritance
QueryDocumentRequest
Inherited Members
Extension Methods

Constructors

QueryDocumentRequest()

Initializes a new instance of the QueryDocumentRequest class for JSON deserialization.

public QueryDocumentRequest()

QueryDocumentRequest(string)

Initializes a new instance of the QueryDocumentRequest class with the specified query.

public QueryDocumentRequest(string query)

Parameters

query string

Query string to perform semantic search.

Properties

MetadataFilters

Filter for RelevantChunk metadata. Each MetadataFilter object should correspond to a unique key. Multiple MetadataFilter objects are joined by logical "AND"s.
Note: Document-level filtering is not supported for this request because a Document name is already specified.
Example query: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]
Example query for a numeric range of values: (year > 2015 AND year <= 2020)
MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
Note: "AND"s for the same key are only supported for numeric values. String values only support "OR"s for the same key.

[JsonPropertyName("metadataFilters")]
public List<MetadataFilter>? MetadataFilters { get; set; }

Property Value

List<MetadataFilter>

Query

Query string to perform semantic search. Required.

[JsonPropertyName("query")]
public string Query { get; set; }

Property Value

string

ResultsCount

The maximum number of RelevantChunks to return. The service may return fewer RelevantChunks. If unspecified, at most 10 RelevantChunks will be returned. The maximum specified result count is 100.

[JsonPropertyName("resultsCount")]
public int? ResultsCount { get; set; }

Property Value

int?

See Also