1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Kgsearch\Resource;
19
20use Google\Service\Kgsearch\SearchResponse;
21
22/**
23 * The "entities" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $kgsearchService = new Google\Service\Kgsearch(...);
27 *   $entities = $kgsearchService->entities;
28 *  </code>
29 */
30class Entities extends \Google\Service\Resource
31{
32  /**
33   * Searches Knowledge Graph for entities that match the constraints. A list of
34   * matched entities will be returned in response, which will be in JSON-LD
35   * format and compatible with http://schema.org (entities.search)
36   *
37   * @param array $optParams Optional parameters.
38   *
39   * @opt_param string ids The list of entity id to be used for search instead of
40   * query string. To specify multiple ids in the HTTP request, repeat the
41   * parameter in the URL as in ...?ids=A=B
42   * @opt_param bool indent Enables indenting of json results.
43   * @opt_param string languages The list of language codes (defined in ISO 693)
44   * to run the query with, e.g. 'en'.
45   * @opt_param int limit Limits the number of entities to be returned.
46   * @opt_param bool prefix Enables prefix match against names and aliases of
47   * entities
48   * @opt_param string query The literal query string for search.
49   * @opt_param string types Restricts returned entities with these types, e.g.
50   * Person (as defined in http://schema.org/Person). If multiple types are
51   * specified, returned entities will contain one or more of these types.
52   * @return SearchResponse
53   */
54  public function search($optParams = [])
55  {
56    $params = [];
57    $params = array_merge($params, $optParams);
58    return $this->call('search', [$params], SearchResponse::class);
59  }
60}
61
62// Adding a class alias for backwards compatibility with the previous class name.
63class_alias(Entities::class, 'Google_Service_Kgsearch_Resource_Entities');
64