1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/contentwarehouse/v1/filters.proto 18 19 package com.google.cloud.contentwarehouse.v1; 20 21 public interface DocumentQueryOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.DocumentQuery) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The query string that matches against the full text of the document and 31 * the searchable properties. 32 * The query partially supports [Google AIP style 33 * syntax](https://google.aip.dev/160). Specifically, the query supports 34 * literals, logical operators, negation operators, comparison operators, and 35 * functions. 36 * Literals: A bare literal value (examples: "42", "Hugo") is a value to be 37 * matched against. It searches over the full text of the document and the 38 * searchable properties. 39 * Logical operators: "AND", "and", "OR", and "or" are binary logical 40 * operators (example: "engineer OR developer"). 41 * Negation operators: "NOT" and "!" are negation operators (example: "NOT 42 * software"). 43 * Comparison operators: support the binary comparison operators =, !=, <, >, 44 * <= and >= for string, numeric, enum, boolean. Also support like operator 45 * `~~` for string. It provides semantic search functionality by parsing, 46 * stemming and doing synonyms expansion against the input query. 47 * To specify a property in the query, the left hand side expression in the 48 * comparison must be the property ID including the parent. The right hand 49 * side must be literals. For example: 50 * "\"projects/123/locations/us\".property_a < 1" matches results whose 51 * "property_a" is less than 1 in project 123 and us location. 52 * The literals and comparison expression can be connected in a single query 53 * (example: "software engineer \"projects/123/locations/us\".salary > 100"). 54 * Functions: supported functions are `LOWER([property_name])` to perform a 55 * case insensitive match and `EMPTY([property_name])` to filter on the 56 * existence of a key. 57 * Support nested expressions connected using parenthesis and logical 58 * operators. The default logical operators is `AND` if there is no operators 59 * between expressions. 60 * The query can be used with other filters e.g. `time_filters` and 61 * `folder_name_filter`. They are connected with `AND` operator under the 62 * hood. 63 * The maximum number of allowed characters is 255. 64 * </pre> 65 * 66 * <code>string query = 1;</code> 67 * 68 * @return The query. 69 */ getQuery()70 java.lang.String getQuery(); 71 /** 72 * 73 * 74 * <pre> 75 * The query string that matches against the full text of the document and 76 * the searchable properties. 77 * The query partially supports [Google AIP style 78 * syntax](https://google.aip.dev/160). Specifically, the query supports 79 * literals, logical operators, negation operators, comparison operators, and 80 * functions. 81 * Literals: A bare literal value (examples: "42", "Hugo") is a value to be 82 * matched against. It searches over the full text of the document and the 83 * searchable properties. 84 * Logical operators: "AND", "and", "OR", and "or" are binary logical 85 * operators (example: "engineer OR developer"). 86 * Negation operators: "NOT" and "!" are negation operators (example: "NOT 87 * software"). 88 * Comparison operators: support the binary comparison operators =, !=, <, >, 89 * <= and >= for string, numeric, enum, boolean. Also support like operator 90 * `~~` for string. It provides semantic search functionality by parsing, 91 * stemming and doing synonyms expansion against the input query. 92 * To specify a property in the query, the left hand side expression in the 93 * comparison must be the property ID including the parent. The right hand 94 * side must be literals. For example: 95 * "\"projects/123/locations/us\".property_a < 1" matches results whose 96 * "property_a" is less than 1 in project 123 and us location. 97 * The literals and comparison expression can be connected in a single query 98 * (example: "software engineer \"projects/123/locations/us\".salary > 100"). 99 * Functions: supported functions are `LOWER([property_name])` to perform a 100 * case insensitive match and `EMPTY([property_name])` to filter on the 101 * existence of a key. 102 * Support nested expressions connected using parenthesis and logical 103 * operators. The default logical operators is `AND` if there is no operators 104 * between expressions. 105 * The query can be used with other filters e.g. `time_filters` and 106 * `folder_name_filter`. They are connected with `AND` operator under the 107 * hood. 108 * The maximum number of allowed characters is 255. 109 * </pre> 110 * 111 * <code>string query = 1;</code> 112 * 113 * @return The bytes for query. 114 */ getQueryBytes()115 com.google.protobuf.ByteString getQueryBytes(); 116 117 /** 118 * 119 * 120 * <pre> 121 * Experimental, do not use. 122 * If the query is a natural language question. False by default. If true, 123 * then the question-answering feature will be used instead of search, and 124 * `result_count` in 125 * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest] 126 * must be set. In addition, all other input fields related to search 127 * (pagination, histograms, etc.) will be ignored. 128 * </pre> 129 * 130 * <code>bool is_nl_query = 12;</code> 131 * 132 * @return The isNlQuery. 133 */ getIsNlQuery()134 boolean getIsNlQuery(); 135 136 /** 137 * 138 * 139 * <pre> 140 * This filter specifies a structured syntax to match against the 141 * [PropertyDefinition].[is_filterable][] marked as `true`. The syntax for 142 * this expression is a subset of SQL syntax. 143 * Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left 144 * of the operator is a property name and the right of the operator is a 145 * number or a quoted string. You must escape backslash (\\) and quote (\") 146 * characters. Supported functions are `LOWER([property_name])` to perform a 147 * case insensitive match and `EMPTY([property_name])` to filter on the 148 * existence of a key. 149 * Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting 150 * (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 151 * comparisons or functions are allowed in the expression. The expression must 152 * be < 6000 bytes in length. 153 * Sample Query: 154 * `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND 155 * driving_years > 10` 156 * </pre> 157 * 158 * <code>string custom_property_filter = 4 [deprecated = true];</code> 159 * 160 * @deprecated google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is 161 * deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104 162 * @return The customPropertyFilter. 163 */ 164 @java.lang.Deprecated getCustomPropertyFilter()165 java.lang.String getCustomPropertyFilter(); 166 /** 167 * 168 * 169 * <pre> 170 * This filter specifies a structured syntax to match against the 171 * [PropertyDefinition].[is_filterable][] marked as `true`. The syntax for 172 * this expression is a subset of SQL syntax. 173 * Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left 174 * of the operator is a property name and the right of the operator is a 175 * number or a quoted string. You must escape backslash (\\) and quote (\") 176 * characters. Supported functions are `LOWER([property_name])` to perform a 177 * case insensitive match and `EMPTY([property_name])` to filter on the 178 * existence of a key. 179 * Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting 180 * (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 181 * comparisons or functions are allowed in the expression. The expression must 182 * be < 6000 bytes in length. 183 * Sample Query: 184 * `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND 185 * driving_years > 10` 186 * </pre> 187 * 188 * <code>string custom_property_filter = 4 [deprecated = true];</code> 189 * 190 * @deprecated google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is 191 * deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104 192 * @return The bytes for customPropertyFilter. 193 */ 194 @java.lang.Deprecated getCustomPropertyFilterBytes()195 com.google.protobuf.ByteString getCustomPropertyFilterBytes(); 196 197 /** 198 * 199 * 200 * <pre> 201 * Documents created/updated within a range specified by this filter are 202 * searched against. 203 * </pre> 204 * 205 * <code>repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;</code> 206 */ getTimeFiltersList()207 java.util.List<com.google.cloud.contentwarehouse.v1.TimeFilter> getTimeFiltersList(); 208 /** 209 * 210 * 211 * <pre> 212 * Documents created/updated within a range specified by this filter are 213 * searched against. 214 * </pre> 215 * 216 * <code>repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;</code> 217 */ getTimeFilters(int index)218 com.google.cloud.contentwarehouse.v1.TimeFilter getTimeFilters(int index); 219 /** 220 * 221 * 222 * <pre> 223 * Documents created/updated within a range specified by this filter are 224 * searched against. 225 * </pre> 226 * 227 * <code>repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;</code> 228 */ getTimeFiltersCount()229 int getTimeFiltersCount(); 230 /** 231 * 232 * 233 * <pre> 234 * Documents created/updated within a range specified by this filter are 235 * searched against. 236 * </pre> 237 * 238 * <code>repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;</code> 239 */ 240 java.util.List<? extends com.google.cloud.contentwarehouse.v1.TimeFilterOrBuilder> getTimeFiltersOrBuilderList()241 getTimeFiltersOrBuilderList(); 242 /** 243 * 244 * 245 * <pre> 246 * Documents created/updated within a range specified by this filter are 247 * searched against. 248 * </pre> 249 * 250 * <code>repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;</code> 251 */ getTimeFiltersOrBuilder(int index)252 com.google.cloud.contentwarehouse.v1.TimeFilterOrBuilder getTimeFiltersOrBuilder(int index); 253 254 /** 255 * 256 * 257 * <pre> 258 * This filter specifies the exact document schema 259 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] 260 * of the documents to search against. 261 * If a value isn't specified, documents within the search results are 262 * associated with any schema. If multiple values are specified, documents 263 * within the search results may be associated with any of the specified 264 * schemas. 265 * At most 20 document schema names are allowed. 266 * </pre> 267 * 268 * <code>repeated string document_schema_names = 6;</code> 269 * 270 * @return A list containing the documentSchemaNames. 271 */ getDocumentSchemaNamesList()272 java.util.List<java.lang.String> getDocumentSchemaNamesList(); 273 /** 274 * 275 * 276 * <pre> 277 * This filter specifies the exact document schema 278 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] 279 * of the documents to search against. 280 * If a value isn't specified, documents within the search results are 281 * associated with any schema. If multiple values are specified, documents 282 * within the search results may be associated with any of the specified 283 * schemas. 284 * At most 20 document schema names are allowed. 285 * </pre> 286 * 287 * <code>repeated string document_schema_names = 6;</code> 288 * 289 * @return The count of documentSchemaNames. 290 */ getDocumentSchemaNamesCount()291 int getDocumentSchemaNamesCount(); 292 /** 293 * 294 * 295 * <pre> 296 * This filter specifies the exact document schema 297 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] 298 * of the documents to search against. 299 * If a value isn't specified, documents within the search results are 300 * associated with any schema. If multiple values are specified, documents 301 * within the search results may be associated with any of the specified 302 * schemas. 303 * At most 20 document schema names are allowed. 304 * </pre> 305 * 306 * <code>repeated string document_schema_names = 6;</code> 307 * 308 * @param index The index of the element to return. 309 * @return The documentSchemaNames at the given index. 310 */ getDocumentSchemaNames(int index)311 java.lang.String getDocumentSchemaNames(int index); 312 /** 313 * 314 * 315 * <pre> 316 * This filter specifies the exact document schema 317 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] 318 * of the documents to search against. 319 * If a value isn't specified, documents within the search results are 320 * associated with any schema. If multiple values are specified, documents 321 * within the search results may be associated with any of the specified 322 * schemas. 323 * At most 20 document schema names are allowed. 324 * </pre> 325 * 326 * <code>repeated string document_schema_names = 6;</code> 327 * 328 * @param index The index of the value to return. 329 * @return The bytes of the documentSchemaNames at the given index. 330 */ getDocumentSchemaNamesBytes(int index)331 com.google.protobuf.ByteString getDocumentSchemaNamesBytes(int index); 332 333 /** 334 * 335 * 336 * <pre> 337 * This filter specifies a structured syntax to match against the 338 * [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] 339 * marked as `true`. The relationship between the PropertyFilters is OR. 340 * </pre> 341 * 342 * <code>repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;</code> 343 */ getPropertyFilterList()344 java.util.List<com.google.cloud.contentwarehouse.v1.PropertyFilter> getPropertyFilterList(); 345 /** 346 * 347 * 348 * <pre> 349 * This filter specifies a structured syntax to match against the 350 * [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] 351 * marked as `true`. The relationship between the PropertyFilters is OR. 352 * </pre> 353 * 354 * <code>repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;</code> 355 */ getPropertyFilter(int index)356 com.google.cloud.contentwarehouse.v1.PropertyFilter getPropertyFilter(int index); 357 /** 358 * 359 * 360 * <pre> 361 * This filter specifies a structured syntax to match against the 362 * [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] 363 * marked as `true`. The relationship between the PropertyFilters is OR. 364 * </pre> 365 * 366 * <code>repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;</code> 367 */ getPropertyFilterCount()368 int getPropertyFilterCount(); 369 /** 370 * 371 * 372 * <pre> 373 * This filter specifies a structured syntax to match against the 374 * [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] 375 * marked as `true`. The relationship between the PropertyFilters is OR. 376 * </pre> 377 * 378 * <code>repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;</code> 379 */ 380 java.util.List<? extends com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder> getPropertyFilterOrBuilderList()381 getPropertyFilterOrBuilderList(); 382 /** 383 * 384 * 385 * <pre> 386 * This filter specifies a structured syntax to match against the 387 * [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] 388 * marked as `true`. The relationship between the PropertyFilters is OR. 389 * </pre> 390 * 391 * <code>repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;</code> 392 */ getPropertyFilterOrBuilder( int index)393 com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder getPropertyFilterOrBuilder( 394 int index); 395 396 /** 397 * 398 * 399 * <pre> 400 * This filter specifies the types of files to return: ALL, FOLDER, or FILE. 401 * If FOLDER or FILE is specified, then only either folders or files will be 402 * returned, respectively. If ALL is specified, both folders and files will be 403 * returned. 404 * If no value is specified, ALL files will be returned. 405 * </pre> 406 * 407 * <code>.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;</code> 408 * 409 * @return Whether the fileTypeFilter field is set. 410 */ hasFileTypeFilter()411 boolean hasFileTypeFilter(); 412 /** 413 * 414 * 415 * <pre> 416 * This filter specifies the types of files to return: ALL, FOLDER, or FILE. 417 * If FOLDER or FILE is specified, then only either folders or files will be 418 * returned, respectively. If ALL is specified, both folders and files will be 419 * returned. 420 * If no value is specified, ALL files will be returned. 421 * </pre> 422 * 423 * <code>.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;</code> 424 * 425 * @return The fileTypeFilter. 426 */ getFileTypeFilter()427 com.google.cloud.contentwarehouse.v1.FileTypeFilter getFileTypeFilter(); 428 /** 429 * 430 * 431 * <pre> 432 * This filter specifies the types of files to return: ALL, FOLDER, or FILE. 433 * If FOLDER or FILE is specified, then only either folders or files will be 434 * returned, respectively. If ALL is specified, both folders and files will be 435 * returned. 436 * If no value is specified, ALL files will be returned. 437 * </pre> 438 * 439 * <code>.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;</code> 440 */ getFileTypeFilterOrBuilder()441 com.google.cloud.contentwarehouse.v1.FileTypeFilterOrBuilder getFileTypeFilterOrBuilder(); 442 443 /** 444 * 445 * 446 * <pre> 447 * Search all the documents under this specified folder. 448 * Format: 449 * projects/{project_number}/locations/{location}/documents/{document_id}. 450 * </pre> 451 * 452 * <code>string folder_name_filter = 9;</code> 453 * 454 * @return The folderNameFilter. 455 */ getFolderNameFilter()456 java.lang.String getFolderNameFilter(); 457 /** 458 * 459 * 460 * <pre> 461 * Search all the documents under this specified folder. 462 * Format: 463 * projects/{project_number}/locations/{location}/documents/{document_id}. 464 * </pre> 465 * 466 * <code>string folder_name_filter = 9;</code> 467 * 468 * @return The bytes for folderNameFilter. 469 */ getFolderNameFilterBytes()470 com.google.protobuf.ByteString getFolderNameFilterBytes(); 471 472 /** 473 * 474 * 475 * <pre> 476 * For custom synonyms. 477 * Customers provide the synonyms based on context. One customer can provide 478 * multiple set of synonyms based on different context. The search query will 479 * be expanded based on the custom synonyms of the query context set. 480 * By default, no custom synonyms wll be applied if no query context is 481 * provided. 482 * It is not supported for CMEK compliant deployment. 483 * </pre> 484 * 485 * <code>repeated string query_context = 10;</code> 486 * 487 * @return A list containing the queryContext. 488 */ getQueryContextList()489 java.util.List<java.lang.String> getQueryContextList(); 490 /** 491 * 492 * 493 * <pre> 494 * For custom synonyms. 495 * Customers provide the synonyms based on context. One customer can provide 496 * multiple set of synonyms based on different context. The search query will 497 * be expanded based on the custom synonyms of the query context set. 498 * By default, no custom synonyms wll be applied if no query context is 499 * provided. 500 * It is not supported for CMEK compliant deployment. 501 * </pre> 502 * 503 * <code>repeated string query_context = 10;</code> 504 * 505 * @return The count of queryContext. 506 */ getQueryContextCount()507 int getQueryContextCount(); 508 /** 509 * 510 * 511 * <pre> 512 * For custom synonyms. 513 * Customers provide the synonyms based on context. One customer can provide 514 * multiple set of synonyms based on different context. The search query will 515 * be expanded based on the custom synonyms of the query context set. 516 * By default, no custom synonyms wll be applied if no query context is 517 * provided. 518 * It is not supported for CMEK compliant deployment. 519 * </pre> 520 * 521 * <code>repeated string query_context = 10;</code> 522 * 523 * @param index The index of the element to return. 524 * @return The queryContext at the given index. 525 */ getQueryContext(int index)526 java.lang.String getQueryContext(int index); 527 /** 528 * 529 * 530 * <pre> 531 * For custom synonyms. 532 * Customers provide the synonyms based on context. One customer can provide 533 * multiple set of synonyms based on different context. The search query will 534 * be expanded based on the custom synonyms of the query context set. 535 * By default, no custom synonyms wll be applied if no query context is 536 * provided. 537 * It is not supported for CMEK compliant deployment. 538 * </pre> 539 * 540 * <code>repeated string query_context = 10;</code> 541 * 542 * @param index The index of the value to return. 543 * @return The bytes of the queryContext at the given index. 544 */ getQueryContextBytes(int index)545 com.google.protobuf.ByteString getQueryContextBytes(int index); 546 547 /** 548 * 549 * 550 * <pre> 551 * The exact creator(s) of the documents to search against. 552 * If a value isn't specified, documents within the search results are 553 * associated with any creator. If multiple values are specified, documents 554 * within the search results may be associated with any of the specified 555 * creators. 556 * </pre> 557 * 558 * <code>repeated string document_creator_filter = 11;</code> 559 * 560 * @return A list containing the documentCreatorFilter. 561 */ getDocumentCreatorFilterList()562 java.util.List<java.lang.String> getDocumentCreatorFilterList(); 563 /** 564 * 565 * 566 * <pre> 567 * The exact creator(s) of the documents to search against. 568 * If a value isn't specified, documents within the search results are 569 * associated with any creator. If multiple values are specified, documents 570 * within the search results may be associated with any of the specified 571 * creators. 572 * </pre> 573 * 574 * <code>repeated string document_creator_filter = 11;</code> 575 * 576 * @return The count of documentCreatorFilter. 577 */ getDocumentCreatorFilterCount()578 int getDocumentCreatorFilterCount(); 579 /** 580 * 581 * 582 * <pre> 583 * The exact creator(s) of the documents to search against. 584 * If a value isn't specified, documents within the search results are 585 * associated with any creator. If multiple values are specified, documents 586 * within the search results may be associated with any of the specified 587 * creators. 588 * </pre> 589 * 590 * <code>repeated string document_creator_filter = 11;</code> 591 * 592 * @param index The index of the element to return. 593 * @return The documentCreatorFilter at the given index. 594 */ getDocumentCreatorFilter(int index)595 java.lang.String getDocumentCreatorFilter(int index); 596 /** 597 * 598 * 599 * <pre> 600 * The exact creator(s) of the documents to search against. 601 * If a value isn't specified, documents within the search results are 602 * associated with any creator. If multiple values are specified, documents 603 * within the search results may be associated with any of the specified 604 * creators. 605 * </pre> 606 * 607 * <code>repeated string document_creator_filter = 11;</code> 608 * 609 * @param index The index of the value to return. 610 * @return The bytes of the documentCreatorFilter at the given index. 611 */ getDocumentCreatorFilterBytes(int index)612 com.google.protobuf.ByteString getDocumentCreatorFilterBytes(int index); 613 614 /** 615 * 616 * 617 * <pre> 618 * To support the custom weighting across document schemas, customers need to 619 * provide the properties to be used to boost the ranking in the search 620 * request. For a search query with CustomWeightsMetadata specified, only the 621 * RetrievalImportance for the properties in the CustomWeightsMetadata will 622 * be honored. 623 * </pre> 624 * 625 * <code>.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13; 626 * </code> 627 * 628 * @return Whether the customWeightsMetadata field is set. 629 */ hasCustomWeightsMetadata()630 boolean hasCustomWeightsMetadata(); 631 /** 632 * 633 * 634 * <pre> 635 * To support the custom weighting across document schemas, customers need to 636 * provide the properties to be used to boost the ranking in the search 637 * request. For a search query with CustomWeightsMetadata specified, only the 638 * RetrievalImportance for the properties in the CustomWeightsMetadata will 639 * be honored. 640 * </pre> 641 * 642 * <code>.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13; 643 * </code> 644 * 645 * @return The customWeightsMetadata. 646 */ getCustomWeightsMetadata()647 com.google.cloud.contentwarehouse.v1.CustomWeightsMetadata getCustomWeightsMetadata(); 648 /** 649 * 650 * 651 * <pre> 652 * To support the custom weighting across document schemas, customers need to 653 * provide the properties to be used to boost the ranking in the search 654 * request. For a search query with CustomWeightsMetadata specified, only the 655 * RetrievalImportance for the properties in the CustomWeightsMetadata will 656 * be honored. 657 * </pre> 658 * 659 * <code>.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13; 660 * </code> 661 */ 662 com.google.cloud.contentwarehouse.v1.CustomWeightsMetadataOrBuilder getCustomWeightsMetadataOrBuilder()663 getCustomWeightsMetadataOrBuilder(); 664 } 665