#}

    Console
    Contact Us Start free

    Enterprise Knowledge Graph client libraries

    This page shows how to get started with the Cloud Client Libraries for the Enterprise Knowledge Graph API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.

    Read more about the Cloud Client Libraries and the older Google API Client Libraries in Client libraries explained .

    Install the client library

    Python 

    pip install --upgrade google-cloud-enterpriseknowledgegraph

    For more information, see Setting Up a Python Development Environment .

    Set up authentication

    To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC) ; the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.

    For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials .

    For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:

    1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:

      gcloud  
init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

    2. If you're using a local shell, then create local authentication credentials for your user account:

      gcloud  
auth  
application-default  
login

      You don't need to do this if you're using Cloud Shell.

      If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity .

      A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC .

    Use the client library

    The following example shows how to use the client library.

    Python 

      from 
  
 __future__ 
  
 import 
 annotations 
 from 
  
 collections.abc 
  
 import 
 Sequence 
 from 
  
 google.cloud 
  
 import 
 enterpriseknowledgegraph 
 as 
 ekg 
 # TODO(developer): Uncomment these variables before running the sample. 
 # project_id = 'YOUR_PROJECT_ID' 
 # location = 'YOUR_GRAPH_LOCATION'      # Values: 'global' 
 # search_query = 'YOUR_SEARCH_QUERY' 
 # languages = ['en']                    # Optional: List of ISO 639-1 Codes 
 # types = ['']                          # Optional: List of schema.org types to return 
 # limit = 20                            # Optional: Number of entities to return 
 def 
  
 search_public_kg_sample 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 search_query 
 : 
 str 
 , 
 languages 
 : 
 Sequence 
 [ 
 str 
 ] 
 = 
 None 
 , 
 types 
 : 
 Sequence 
 [ 
 str 
 ] 
 = 
 None 
 , 
 limit 
 : 
 int 
 = 
 20 
 , 
 ): 
 # Create a client 
 client 
 = 
 ekg 
 . 
 EnterpriseKnowledgeGraphServiceClient 
 () 
 # The full resource name of the location 
 # e.g. projects/{project_id}/locations/{location} 
 parent 
 = 
 client 
 . 
 common_location_path 
 ( 
 project 
 = 
 project_id 
 , 
 location 
 = 
 location 
 ) 
 # Initialize request argument(s) 
 request 
 = 
 ekg 
 . 
 SearchPublicKgRequest 
 ( 
 parent 
 = 
 parent 
 , 
 query 
 = 
 search_query 
 , 
 languages 
 = 
 languages 
 , 
 types 
 = 
 types 
 , 
 limit 
 = 
 limit 
 , 
 ) 
 # Make the request 
 response 
 = 
 client 
 . 
 search_public_kg 
 ( 
 request 
 = 
 request 
 ) 
 print 
 ( 
 f 
 "Search Query: 
 { 
 search_query 
 } 
 \n 
 " 
 ) 
 # Extract and print date from response 
 for 
 item 
 in 
 response 
 . 
 item_list_element 
 : 
 result 
 = 
 item 
 . 
 get 
 ( 
 "result" 
 ) 
 print 
 ( 
 f 
 "Name: 
 { 
 result 
 . 
 get 
 ( 
 'name' 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "- Description: 
 { 
 result 
 . 
 get 
 ( 
 'description' 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "- Types: 
 { 
 result 
 . 
 get 
 ( 
 '@type' 
 ) 
 } 
 \n 
 " 
 ) 
 detailed_description 
 = 
 result 
 . 
 get 
 ( 
 "detailedDescription" 
 ) 
 if 
 detailed_description 
 : 
 print 
 ( 
 "- Detailed Description:" 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 - Article Body: 
 { 
 detailed_description 
 . 
 get 
 ( 
 'articleBody' 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 - URL: 
 { 
 detailed_description 
 . 
 get 
 ( 
 'url' 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 - License: 
 { 
 detailed_description 
 . 
 get 
 ( 
 'license' 
 ) 
 } 
 \n 
 " 
 ) 
 print 
 ( 
 f 
 "- Cloud MID: 
 { 
 result 
 . 
 get 
 ( 
 '@id' 
 ) 
 } 
 " 
 ) 
 for 
 identifier 
 in 
 result 
 . 
 get 
 ( 
 "identifier" 
 ): 
 print 
 ( 
 f 
 " 
 \t 
 - 
 { 
 identifier 
 . 
 get 
 ( 
 'name' 
 ) 
 } 
 : 
 { 
 identifier 
 . 
 get 
 ( 
 'value' 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 " 
 \n 
 " 
 )

    Additional resources

    Python

    The following list contains links to more resources related to the client library for Python:
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: