:::tip \*说明 **Viking AI Search** is an enterprise\-grade AI search product powered by generative AI. It uses multimodal semantic representation and large model understanding, combined with ByteDance's best practices in information retrieval, to provide an out\-of\-the\-box AI search platform. This service helps customers build and integrate end\-to\-end multimodal search and recommendation capabilities for images and text. * To experience more of Viking AI Search's capabilities, visit: [Viking AI Search Engine, an integrated intelligent engine for enterprise search, recommendation, and Q&A](https://www.volcengine.com/product/AI-Search-Rec). ::: # Authentication Mechanism AI Search Data Plane APIs — including APIs for search, conversation, and recommendation, and for uploading, deleting, and querying data — support two authentication methods: 1. **API Key authentication:** A simple method that you can configure and use directly from the AI Search console. 2. **Access Key authentication:** The standard method for authenticating cloud resource access in the Volcano Engine product system, designed for enterprises that require fine\-grained resource and permission management. # Method 1: API Key Authentication ## Create and get an API Key 1. Log in to the AI Search Engine console and go to the [API Key Management](https://console.volcengine.com/aisearch/platform/home/api-key) page. You can view existing API Keys or create a new one.

2. View and copy the API Key from the API Key list.

## Construct Signature API Key signature authentication requires adding an `Authorization` header to the HTTP request header as follows: ```Bash Authorization: Bearer ``` ## API Call Example ```Shell curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/${application_id}/search/{scene_id}' \ -H 'Content-Type: application/json' \ -H 'Authorization:Bearer ' \ -d '{ "query": { "text": "Sci-fi" }, "page_number": 1, "page_size": 5, "user": { "_user_id": "user_123" }, "filter": { "op": "must", "field": "director", "conds": ["Mr X"] }, "dataset_id": "106265704" }' ``` # Method 2: Authenticate with a Volcano Access Key ## Get an Access Key An Access Key includes an Access Key ID (AK) and an Access Key Secret (SK). The Access Key ID identifies the user, and the Access Key Secret verifies the user's identity. Keep both values secure. :::tip \*Note If you are using a sub\-account, confirm with your enterprise administrator that it has permission to create and read Access Keys. ::: Obtain your AK/SK as follows. For more details, refer to [Access Key Management](https://www.volcengine.com/docs/6291/65568). 1. Click **API Access Key** in the account dropdown menu in the top\-right corner to go to the corresponding page.

2. Click **New Key** to get an AK/SK. Use these as credentials to call the APIs of your integrated applications.

**Note:** For security reasons, create a sub\-account and use its AK/SK. ## Create a signature 1. Use the Access Key to create a signature. For details on the signature method and creation mechanism, see [Signature Method](https://www.volcengine.com/docs/6369/67269). Use the multi\-language [official SDK](https://www.volcengine.com/docs/6369/156029) provided by Volcano Engine to create the signature. **AI Search Platform parameters for signatures** ```Plain Text Service：aisearch Region：cn-beijing ``` 2. Add the created signature string to the HTTP request header as `Authorization`. ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/{api action}' -H 'Content-Type: application/json' \ -H 'Authorization: HMAC-SHA256 Credential={AccessKeyId}/{CredentialScope}, SignedHeaders={SignedHeaders}, Signature={Signature}' \ -d '{ "key": "value" }' ``` ## API Call Example ### Install the Volcano Engine Package ```mixin-react return ( com.volcengine volc-sdk-java 最新版本 \`\`\` `}> ); ``` ### Generate a Signature and Test the Call ```mixin-react return ( params, String body, String ak, String sk) throws Exception { SignableRequest request = new SignableRequest(); request.setMethod(method); request.setHeader("Accept", "application/json"); request.setHeader("Content-Type", "application/json"); request.setHeader("Host", HOST); request.setEntity(new StringEntity(body, "utf-8")); URIBuilder builder = request.getUriBuilder(); builder.setScheme(SCHEMA); builder.setHost(host); builder.setPath(path); if (params != null) { builder.setParameters(params); } RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(5000).setConnectTimeout(2000).build(); request.setConfig(requestConfig); Credentials credentials = new Credentials(REGION, SERVICE); credentials.setAccessKeyID(ak); credentials.setSecretAccessKey(sk); // Signature ISignerV4 ISigner = new SignerV4Impl(); ISigner.sign(request, credentials); return request; } public static void search_demo() { try { String path = String.format("/api/v1/application/%s/search", "应用id"); Map bodyData = new HashMap<>(); bodyData.put("dataset_id", "实际数据集id"); bodyData.put("page_number", 1); bodyData.put("page_size", 10); Map query = new HashMap<>(); query.put("text", "测试"); bodyData.put("query", query); Map user = new HashMap<>(); user.put("_user_id", "mock_user_id"); bodyData.put("user", user); Gson gson = new Gson(); String body = gson.toJson(bodyData); SignableRequest signableRequest = prepareRequest(HOST, path, "POST", null, body, AK, SK); URI uri = new URIBuilder().setScheme(SCHEMA).setHost(HOST).setPath(path).build(); HttpPost httpPost = new HttpPost(uri); httpPost.setConfig(signableRequest.getConfig()); httpPost.setEntity(signableRequest.getEntity()); for (Header header : signableRequest.getAllHeaders()) { httpPost.setHeader(header.getName(), header.getValue()); } HttpClient httpClient = HttpClients.createDefault(); HttpResponse response = httpClient.execute(httpPost); int statusCode = response.getStatusLine().getStatusCode(); String responseBody = EntityUtils.toString(response.getEntity()); System.out.println(statusCode); System.out.println(responseBody); } catch (IOException e) { System.out.println("请求出错: " + e.getMessage()); } catch (Exception e) { throw new RuntimeException(e); } } public static void chat_search_demo() { // Note that chat_search is a streaming API. try { String path = String.format("/api/v1/application/%s/chat_search", "应用id"); Map bodyData = new HashMap<>(); bodyData.put("session_id", "mock_session_id"); Map inputMessage = new HashMap<>(); Map content = new HashMap<>(); content.put("type", "text"); content.put("text", "帮我推荐几部喜剧?"); inputMessage.put("content", Collections.singletonList(content)); bodyData.put("input_message", inputMessage); Map user = new HashMap<>(); user.put("_user_id", "mock_user_id"); bodyData.put("user", user); Gson gson = new Gson(); String body = gson.toJson(bodyData); SignableRequest signableRequest = prepareRequest(HOST, path, "POST", null, body, AK, SK); URI uri = new URIBuilder().setScheme(SCHEMA).setHost(HOST).setPath(path).build(); HttpPost httpPost = new HttpPost(uri); httpPost.setConfig(signableRequest.getConfig()); httpPost.setEntity(signableRequest.getEntity()); for (Header header : signableRequest.getAllHeaders()) { httpPost.setHeader(header.getName(), header.getValue()); } HttpClient httpClient = HttpClients.createDefault(); HttpResponse response = httpClient.execute(httpPost); int statusCode = response.getStatusLine().getStatusCode(); if (statusCode == 200) { // Note: Streaming processing is required. processStreamResponse(response.getEntity()); } else { System.err.println("HTTP请求失败，状态码: " + statusCode); String responseBody = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8); System.err.println("响应内容: " + responseBody); } } catch (IOException e) { System.out.println("请求出错: " + e.getMessage()); } catch (Exception e) { throw new RuntimeException(e); } } private static void processStreamResponse(HttpEntity entity) throws IOException { try (InputStream inputStream = entity.getContent(); BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8), 128)) { String line; // Read and print the response content line by line while ((line = reader.readLine()) != null) { System.out.println(line); } } finally { EntityUtils.consumeQuietly(entity); } } public static void main(String[] args) { search_demo(); chat_search_demo(); } } \`\`\` `}> ); ``` :::tip \*说明 To explore more Viking AI search capabilities, visit: [Viking AI Search Engine, the all-in-one intelligent engine for enterprise search, recommendations, and Q&A](https://www.volcengine.com/product/AI-Search-Rec) :::