Multimodal search API

Prerequisites

You must have Python 3.8 or later installed.

Installation

pip3 install alibabacloud_iqs20241111==1.10.2

Sample code

• Synchronous call

import os

from Tea.exceptions import TeaException
from alibabacloud_iqs20241111 import models
from alibabacloud_iqs20241111.client import Client
from alibabacloud_tea_openapi import models as open_api_models


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Client:
        config = open_api_models.Config(
            # TODO: Replace with your Access Key ID and Access Key Secret. We recommend loading them from environment variables.
            access_key_id=os.environ.get('YOUR_ACCESS_KEY'),
            access_key_secret=os.environ.get('YOUR_ACCESS_SECRET')
        )
        config.endpoint = f'iqs.cn-zhangjiakou.aliyuncs.com'
        return Client(config)

    @staticmethod
    def main() -> None:
        client = Sample.create_client()
        advancedParams = {
            "excludeSites": "www.360doc.com,weibo.com"
        }
        multimodal_search_body = models.MultimodalSearchBody(
            query='lion',
            advanced_params=advancedParams
        )
        request = models.MultimodalSearchRequest(
            body=multimodal_search_body
        )
        try:
            response = client.multimodal_search(request)
            print(
                f"API call successful. Request ID: {response.body.request_id}, Results: {len(response.body.image_items)}, Search time (ms): {response.body.search_information.search_time}")
            for index, item in enumerate(response.body.image_items):
                print(f"Result {index + 1}. {'-' * 20}")
                print(f"  Title: {item.title}")
                print(f"  Image URL: {item.image_url}")
                print(f"  Host Page URL: {item.host_page_url}")
                print(f"  Published Time: {item.published_time}")
                print(f"  Width: {item.width}")
                print(f"  Height: {item.height}")

        except TeaException as e:
            code = e.code
            request_id = e.data.get("requestId")
            message = e.data.get("message")
            print(f"API call failed. Request ID: {request_id}, Error code: {code}, Message: {message}")


if __name__ == '__main__':
    Sample.main()

• Asynchronous call

import os
import asyncio

from Tea.exceptions import TeaException
from alibabacloud_iqs20241111 import models
from alibabacloud_iqs20241111.client import Client
from alibabacloud_tea_openapi import models as open_api_models


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Client:
        config = open_api_models.Config(
            # TODO: Replace with your Access Key ID and Access Key Secret. We recommend loading them from environment variables.
            access_key_id=os.environ.get('YOUR_ACCESS_KEY'),
            access_key_secret=os.environ.get('YOUR_ACCESS_SECRET')
        )
        config.endpoint = f'iqs.cn-zhangjiakou.aliyuncs.com'
        return Client(config)

    async def main_async(self) -> None:
        client = self.create_client()
        advancedParams = {
            "excludeSites": "www.360doc.com,weibo.com"
        }
        multimodal_search_body = models.MultimodalSearchBody(
            query='lion',
            advanced_params=advancedParams
        )
        request = models.MultimodalSearchRequest(
            body=multimodal_search_body
        )
        try:
            response = await client.multimodal_search_async(request)
            print(
                f"API call successful. Request ID: {response.body.request_id}, Results: {len(response.body.image_items)}, Search time (ms): {response.body.search_information.search_time}")
            for index, item in enumerate(response.body.image_items):
                print(f"Result {index + 1}. {'-' * 20}")
                print(f"  Title: {item.title}")
                print(f"  Image URL: {item.image_url}")
                print(f"  Host Page URL: {item.host_page_url}")
                print(f"  Published Time: {item.published_time}")
                print(f"  Width: {item.width}")
                print(f"  Height: {item.height}")

        except TeaException as e:
            code = e.code
            request_id = e.data.get("requestId")
            message = e.data.get("message")
            print(f"API call failed. Request ID: {request_id}, Error code: {code}, Message: {message}")


if __name__ == '__main__':
    sample = Sample()
    asyncio.run(sample.main_async())

Prerequisites

You must have Java 8 or later installed.

Maven dependency

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>iqs20241111</artifactId>
    <version>1.10.2</version>
</dependency>

Sample code

package com.aliyun.iqs.example;

import com.aliyun.iqs20241111.Client;
import com.aliyun.iqs20241111.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

import java.util.HashMap;
import java.util.Map;

public class MultimodalSearchExample {
    public static void main(String[] args) throws Exception {
        Client client = initClient();
        invoke(client, "lion", "www.360doc.com,weibo.com");
    }

    private static Client initClient() throws Exception {
        // TODO: Replace with your Access Key ID and Access Key Secret. We recommend loading them from environment variables.
        String accessKeyId = System.getenv("YOUR_ACCESS_KEY");
        String accessKeySecret = System.getenv("YOUR_ACCESS_SECRET");

        Config config = new Config()
            .setAccessKeyId(accessKeyId)
            .setAccessKeySecret(accessKeySecret);

        config.setEndpoint("iqs.cn-zhangjiakou.aliyuncs.com");
        return new Client(config);
    }

    private static void invoke(Client client, String query, String excludeSites) {

        MultimodalSearchBody input = new MultimodalSearchBody();
        input.setQuery(query);
        Map<String, String> advancedParams = new HashMap<>();
        advancedParams.put("excludeSites",excludeSites);
        input.setAdvancedParams(advancedParams);
        MultimodalSearchRequest request = new MultimodalSearchRequest().setBody(input);

        try {
            long start = System.currentTimeMillis();
            MultimodalSearchResponse response = client.multimodalSearch(request);
            MultimodalSearchResponseBody result = response.getBody();
            long latency = System.currentTimeMillis() - start;
            System.out.println("Latency: " + latency + " ms, Request ID: " + result.getRequestId());
            printOutput(result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static void printOutput(MultimodalSearchResponseBody output) {
        // Use GsonBuilder to create a formatted Gson instance.
        Gson gson = new GsonBuilder()
            .setPrettyPrinting()
            .disableHtmlEscaping()
            .create();

        // Print the formatted JSON.
        String prettyJson = gson.toJson(output);
        System.out.println(prettyJson);
    }
}

Prerequisites

You must have Go 1.10.x or a later version installed.

Installation

require (
  github.com/alibabacloud-go/iqs-20241111 v1.10.2
  github.com/alibabacloud-go/darabonba-openapi/v2 v2.0.10
)

Sample code

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	iqs20241111 "github.com/alibabacloud-go/iqs-20241111/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

const endpointURL = "iqs.cn-zhangjiakou.aliyuncs.com"

func createClient() (*iqs20241111.Client, error) {
	// TODO: Replace with your Access Key ID and Access Key Secret. We recommend loading them from environment variables.
	accessKeyID := os.Getenv("YOUR_ACCESS_KEY")
	accessKeySecret := os.Getenv("YOUR_ACCESS_SECRET")

	if accessKeyID == "" || accessKeySecret == "" {
		return nil, fmt.Errorf("YOUR_ACCESS_KEY or YOUR_ACCESS_SECRET environment variable is not set")
	}

	config := &openapi.Config{
		AccessKeyId:     tea.String(accessKeyID),
		AccessKeySecret: tea.String(accessKeySecret),
		Endpoint:        tea.String(endpointURL),
	}

	return iqs20241111.NewClient(config)
}

func runMultimodalSearch(client *iqs20241111.Client) error {
	body := &iqs20241111.MultimodalSearchBody{
		Query: tea.String("lion"),
		AdvancedParams: map[string]*string{
			"excludeSites": tea.String("www.360doc.com,weibo.com"),
		},
	}
	request := &iqs20241111.MultimodalSearchRequest{
		Body: body,
	}
	runtime := &util.RuntimeOptions{}

	resp, err := client.MultimodalSearchWithOptions(request, nil, runtime)
	if err != nil {
		return fmt.Errorf("multimodal search failed: %w", err)
	}

	// Pretty-print the JSON response
	jsonBytes, err := json.MarshalIndent(resp.Body, "", "  ")
	if err != nil {
		return fmt.Errorf("failed to marshal response to JSON: %w", err)
	}

	fmt.Printf("Request ID: %s\nResponse: %s\n", *resp.Body.RequestId, string(jsonBytes))
	return nil
}

func main() {
	client, err := createClient()
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	if err := runMultimodalSearch(client); err != nil {
		log.Fatalf("Error running multimodal search: %v", err)
	}
}