Categorygithub.com/const-cloudinary/analysis-go
modulepackage
0.0.0-20241229141555-fd84c79a95ef
Repository: https://github.com/const-cloudinary/analysis-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
0
Files
3.9k SLOC

# README

Cloudinary Analysis API Go SDK

Go Reference Go Report Card codecov

Developer-friendly & type-safe Go SDK specifically catered to leverage github.com/const-cloudinary/analysis-go API.

Summary

Analyze API (Beta): Use the Analyze API to analyze any external asset and return details based on the type of analysis requested.

Currently supports the following analysis options:

Notes:

  • The Analyze API is currently in development and is available as a Public Beta, which means we value your feedback, so please feel free to share any thoughts with us.
  • The analysis options require an active subscription to the relevant add-on. Learn more about registering for add-ons.

The API supports both Basic Authentication using your Cloudinary API Key and API Secret (which can be found on the Dashboard page of your Cloudinary Console) or OAuth2 (Contact support for more information regarding OAuth).

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/const-cloudinary/analysis-go

SDK Example Usage

Example

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Analysis

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set cloud_name to "your-cloud-name" at SDK initialization and then you do not have to pass the same value on calls to operations like AnalyzeAiVisionGeneral. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. Global parameters can also be set via environment variable.

NameTypeDescriptionEnvironment
CloudNamestringThe name of your Cloudinary cloudCLOUDINARY_CLOUD_NAME

Example

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"github.com/const-cloudinary/analysis-go/retry"
	"log"
	"models/operations"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"), operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"github.com/const-cloudinary/analysis-go/retry"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the AnalyzeAiVisionGeneral function may return the following errors:

Error TypeStatus CodeContent Type
sdkerrors.ErrorResponse400, 401, 403, 404, 407, 413, 414, 415, 422, 429, 431, 500, 501, 502, 503, 505, 506, 507, 508, 510, 511application/json
sdkerrors.Timeout408, 504application/json
sdkerrors.SDKError4XX, 5XX*/*

Example

package main

import (
	"context"
	"errors"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"github.com/const-cloudinary/analysis-go/models/sdkerrors"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {

		var e *sdkerrors.ErrorResponse
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.Timeout
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithServerURL("https://api.cloudinary.com/v2"),
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

NameTypeSchemeEnvironment Variable
BasicAuthhttpHTTP BasicCLOUDINARY_BASIC_AUTH
OAuth2oauth2OAuth2 tokenCLOUDINARY_O_AUTH2

You can set the security parameters through the WithSecurity option when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

package main

import (
	"context"
	analysisgo "github.com/const-cloudinary/analysis-go"
	"github.com/const-cloudinary/analysis-go/models/components"
	"log"
	"os"
)

func main() {
	s := analysisgo.New(
		analysisgo.WithSecurity(components.Security{
			BasicAuth: &components.SchemeBasicAuth{
				Username: os.Getenv(""),
				Password: os.Getenv(""),
			},
		}),
		analysisgo.WithCloudName("your-cloud-name"),
	)

	ctx := context.Background()
	res, err := s.Analysis.AnalyzeAiVisionGeneral(ctx, components.AnalyzeAIVisionGeneralRequest{
		Source: components.CreateSourceURI(
			components.URI{
				URI: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
			},
		),
		Prompts: []string{
			"Describe this image in detail",
			"Does this image contain an insect?",
		},
	}, analysisgo.String("your-cloud-name"))
	if err != nil {
		log.Fatal(err)
	}
	if res.AnalyzeAIVisionGeneralResponse != nil {
		// handle response
	}
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Bool provides a helper function to return a pointer to a bool.
Float32 provides a helper function to return a pointer to a float32.
Float64 provides a helper function to return a pointer to a float64.
Int provides a helper function to return a pointer to an int.
Int64 provides a helper function to return a pointer to an int64.
New creates a new instance of the SDK with the provided options.
Pointer provides a helper function to return a pointer to a type.
String provides a helper function to return a pointer to a string.
WithClient allows the overriding of the default HTTP client used by the SDK.
WithCloudName allows setting the CloudName parameter for all supported operations.
No description provided by the author
WithSecurity configures the SDK to use the provided security details.
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication.
WithServerIndex allows the overriding of the default server by index.
WithServerURL allows the overriding of the default server URL.
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters.
WithTimeout Optional request timeout applied to each operation.

# Variables

ServerList contains the list of servers available to the SDK.

# Structs

Analysis - Analyze API (Beta): Use the Analyze API to analyze any external asset and return details based on the type of analysis requested.
AnalysisSDK - Analyze assets.

# Interfaces

HTTPClient provides an interface for suplying the SDK with a custom HTTP client.

# Type aliases

No description provided by the author