Class GoogleCloudContentwarehouseV1DocumentQuery

Inheritance
object
GoogleCloudContentwarehouseV1DocumentQuery
Implements
Inherited Members
Namespace: Google.Apis.Contentwarehouse.v1.Data
Assembly: Google.Apis.Contentwarehouse.v1.dll
Syntax
public class GoogleCloudContentwarehouseV1DocumentQuery : IDirectResponseSchema

Properties

CustomPropertyFilter

This filter specifies a structured syntax to match against the [PropertyDefinition].is_filterable marked as true. The syntax for this expression is a subset of SQL syntax. Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a property name and the right of the operator is a number or a quoted string. You must escape backslash (\) and quote (") characters. Supported functions are LOWER([property_name]) to perform a case insensitive match and EMPTY([property_name]) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

Declaration
[JsonProperty("customPropertyFilter")]
public virtual string CustomPropertyFilter { get; set; }
Property Value
Type Description
string

CustomWeightsMetadata

To support the custom weighting across document schemas, customers need to provide the properties to be used to boost the ranking in the search request. For a search query with CustomWeightsMetadata specified, only the RetrievalImportance for the properties in the CustomWeightsMetadata will be honored.

Declaration
[JsonProperty("customWeightsMetadata")]
public virtual GoogleCloudContentwarehouseV1CustomWeightsMetadata CustomWeightsMetadata { get; set; }
Property Value
Type Description
GoogleCloudContentwarehouseV1CustomWeightsMetadata

DocumentCreatorFilter

The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.

Declaration
[JsonProperty("documentCreatorFilter")]
public virtual IList<string> DocumentCreatorFilter { get; set; }
Property Value
Type Description
IList<string>

DocumentNameFilter

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

Declaration
[JsonProperty("documentNameFilter")]
public virtual IList<string> DocumentNameFilter { get; set; }
Property Value
Type Description
IList<string>

DocumentSchemaNames

This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.

Declaration
[JsonProperty("documentSchemaNames")]
public virtual IList<string> DocumentSchemaNames { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FileTypeFilter

This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned.

Declaration
[JsonProperty("fileTypeFilter")]
public virtual GoogleCloudContentwarehouseV1FileTypeFilter FileTypeFilter { get; set; }
Property Value
Type Description
GoogleCloudContentwarehouseV1FileTypeFilter

FolderNameFilter

Search all the documents under this specified folder. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

Declaration
[JsonProperty("folderNameFilter")]
public virtual string FolderNameFilter { get; set; }
Property Value
Type Description
string

IsNlQuery

Experimental, do not use. If the query is a natural language question. False by default. If true, then the question-answering feature will be used instead of search, and result_count in SearchDocumentsRequest must be set. In addition, all other input fields related to search (pagination, histograms, etc.) will be ignored.

Declaration
[JsonProperty("isNlQuery")]
public virtual bool? IsNlQuery { get; set; }
Property Value
Type Description
bool?

PropertyFilter

This filter specifies a structured syntax to match against the PropertyDefinition.is_filterable marked as true. The relationship between the PropertyFilters is OR.

Declaration
[JsonProperty("propertyFilter")]
public virtual IList<GoogleCloudContentwarehouseV1PropertyFilter> PropertyFilter { get; set; }
Property Value
Type Description
IList<GoogleCloudContentwarehouseV1PropertyFilter>

Query

The query string that matches against the full text of the document and the searchable properties. The query partially supports Google AIP style syntax. Specifically, the query supports literals, logical operators, negation operators, comparison operators, and functions. Literals: A bare literal value (examples: "42", "Hugo") is a value to be matched against. It searches over the full text of the document and the searchable properties. Logical operators: "AND", "and", "OR", and "or" are binary logical operators (example: "engineer OR developer"). Negation operators: "NOT" and "!" are negation operators (example: "NOT software"). Comparison operators: support the binary comparison operators =, !=, &lt;, &gt;, &lt;= and &gt;= for string, numeric, enum, boolean. Also support like operator ~~ for string. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. To specify a property in the query, the left hand side expression in the comparison must be the property ID including the parent. The right hand side must be literals. For example: ""projects/123/locations/us".property_a &lt; 1" matches results whose "property_a" is less than 1 in project 123 and us location. The literals and comparison expression can be connected in a single query (example: "software engineer "projects/123/locations/us".salary &gt; 100"). Functions: supported functions are LOWER([property_name]) to perform a case insensitive match and EMPTY([property_name]) to filter on the existence of a key. Support nested expressions connected using parenthesis and logical operators. The default logical operators is AND if there is no operators between expressions. The query can be used with other filters e.g. time_filters and folder_name_filter. They are connected with AND operator under the hood. The maximum number of allowed characters is 255.

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

QueryContext

For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.

Declaration
[JsonProperty("queryContext")]
public virtual IList<string> QueryContext { get; set; }
Property Value
Type Description
IList<string>

TimeFilters

Documents created/updated within a range specified by this filter are searched against.

Declaration
[JsonProperty("timeFilters")]
public virtual IList<GoogleCloudContentwarehouseV1TimeFilter> TimeFilters { get; set; }
Property Value
Type Description
IList<GoogleCloudContentwarehouseV1TimeFilter>

Implements