Edit

Bagikan melalui

Quickstart: Use the Bing Autosuggest Go client library

  • Artikel

Get started with the Bing Autosuggest client library for Go. Follow these steps to install the library and try out our examples for basic tasks.

Use the Bing Autosuggest client library for Go to get search suggestions based on partial query strings.

Reference documentation | Library source code | Sample code

Prerequisites

Begin using the Bing Autosuggest client library by creating an Azure resource. Choose the resource type below that's right for you:

Create environment variables

Note

The endpoints for resources created after July 1, 2019 use the custom subdomain format shown below. For more information and a complete list of regional endpoints, see Custom subdomain names for Cognitive Services.

Using your key and endpoint from the resource you created, create two environment variables for authentication:

  • AUTOSUGGEST_SUBSCRIPTION_KEY: The resource key for authenticating your requests.
  • AUTOSUGGEST_ENDPOINT: The resource endpoint for sending API requests. It should look like this: https://<your-custom-subdomain>.api.cognitive.microsoft.com

Use the instructions for your operating system.

setx BING_AUTOSUGGEST_SUBSCRIPTION_KEY <replace-with-your-autosuggest-api-key>
setx BING_AUTOSUGGEST_ENDPOINT <replace-with-your-autosuggest-api-endpoint>

After you add the environment variable, restart the console window.

Create a new Go project

In a console window (cmd, PowerShell, Terminal, Bash), create a new workspace for your Go project and navigate to it. Your workspace will contain three folders:

  • src: This directory contains source code and packages. Any packages installed with the go get command will reside here.
  • pkg: This directory contains the compiled Go package objects. These files all have an .a extension.
  • bin: This directory contains the binary executable files that are created when you run go install.

Tip

Learn more about the structure of a Go workspace. This guide includes information for setting $GOPATH and $GOROOT.

Let's create a workspace called my-app and the required sub directories for src, pkg, and bin:

$ mkdir -p my-app/{src, bin, pkg}  
$ cd my-app

Install the client library for Go

Now, let's install the client library for Go:

$ go get -u <library-location-or-url>

or if you use dep, within your repo run:

$ dep ensure -add <library-location-or-url>

Create your Go application

Next, let's create a file named src/sample-app.go:

$ cd src
$ touch sample-app.go

Open sample-app.go, add the package name, and then import the following libraries:

package main

import (
    "context"
    "fmt"
    "github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/autosuggest"
    "github.com/Azure/go-autorest/autorest"
    "log"
    "os"
)

Create a function named main. Then, create environment variables for your Bing Autosuggest key and endpoint:

func main() {
    // Add your Bing Autosuggest subscription key to your environment variables.
    if "" == os.Getenv("BING_AUTOSUGGEST_SUBSCRIPTION_KEY") {
        log.Fatal("Please set/export the environment variable BING_AUTOSUGGEST_SUBSCRIPTION_KEY.")
    }
    // Add your Bing Autosuggest endpoint to your environment variables.
    var subscription_key string = os.Getenv("BING_AUTOSUGGEST_ENDPOINT")
    if "" == os.Getenv("BING_AUTOSUGGEST_ENDPOINT") {
        log.Fatal("Please set/export the environment variable BING_AUTOSUGGEST_ENDPOINT.")
    }
    var endpoint string = os.Getenv("BING_AUTOSUGGEST_ENDPOINT")
}

Code examples

These code samples show you how to complete basic tasks using the Bing Autosuggest client library for Go:

Authenticate the client

Note

This quickstart assumes you've created an environment variable for your Bing autosuggest key, named BING_AUTOSUGGEST_SUBSCRIPTION_KEY, and one for your endpoint named BING_AUTOSUGGEST_ENDPOINT.

In the main() function, instantiate a client with your endpoint and key.

// Get the context, which is required by the SDK methods.
ctx := context.Background()

client := autosuggest.New()
// Set the subscription key on the client.
client.Authorizer = autorest.NewCognitiveServicesAuthorizer(subscription_key)
client.Endpoint = endpoint

Send an API request

In the same method, use the client's AutoSuggestMethodAsync method to send a query to Bing. Then, iterate over the Suggestions response, and print the first suggestion.

// This should return the query suggestion "xbox."
result, err := client.AutoSuggest (ctx, "xb", "", "", "", "", "", "", "", "", "", "", []autosuggest.ResponseFormat{"Json"})
if nil != err {
    log.Fatal(err)
}

groups := *result.SuggestionGroups
if len(groups) > 0 {
    group, _ := groups[0].AsSuggestionsSuggestionGroup()
    fmt.Printf ("First suggestion group: %s\n", (*group).Name)
    suggestions := *(*group).SearchSuggestions
    if len(suggestions) > 0 {
        fmt.Println("First suggestion:")
        fmt.Printf("Query: %s\n", *suggestions[0].Query)
        fmt.Printf("Display text: %s\n", *suggestions[0].DisplayText)
    } else {
        fmt.Println("No suggestions found in this group.")
    }
} else {
    fmt.Println("No suggestions found.")
}

Run the application

Run your Go application with the go run [arguments] command from your application directory.

go run sample-app.go

Next steps

Bing Autosuggest tutorial

See also