findai

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 8, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

README

Find AI Go API Library

Go Reference

The Find AI Go library provides convenient access to the Find AI REST API from applications written in Go. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

import (
	"github.com/Find-AI/find-ai-go" // imported as findai
)

Or to pin the version:

go get -u 'github.com/Find-AI/find-ai-go@v1.2.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"

	"github.com/Find-AI/find-ai-go"
	"github.com/Find-AI/find-ai-go/option"
)

func main() {
	client := findai.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("FIND_AI_API_KEY")
	)
	searchGetResponses, err := client.Searches.Get(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: findai.F("hello"),

	// Explicitly send `"description": null`
	Description: findai.Null[string](),

	Point: findai.F(findai.Point{
		X: findai.Int(0),
		Y: findai.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: findai.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := findai.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Searches.Get(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *findai.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Searches.Get(context.TODO(), "id")
if err != nil {
	var apierr *findai.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/v1/searches/{id}": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Searches.Get(
	ctx,
	"id",
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper findai.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := findai.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Searches.Get(
	context.TODO(),
	"id",
	option.WithMaxRetries(5),
)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   findai.F("id_xxxx"),
    Data: findai.F(FooNewParamsData{
        FirstName: findai.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := findai.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type Client 

type Client struct {
	Options           []option.RequestOption
	CompanyEnrichment *CompanyEnrichmentService
	PeopleEnrichment  *PeopleEnrichmentService
	Searches          *SearchService
}

Client creates a struct with services and top level methods that help with interacting with the find-ai API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (FIND_AI_API_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned [url.Values] will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CompanyEnrichmentEnrichService 

type CompanyEnrichmentEnrichService struct {
	Options []option.RequestOption
}

CompanyEnrichmentEnrichService contains methods and other services that help with interacting with the find-ai API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCompanyEnrichmentEnrichService method instead.

func NewCompanyEnrichmentEnrichService 

func NewCompanyEnrichmentEnrichService(opts ...option.RequestOption) (r *CompanyEnrichmentEnrichService)

NewCompanyEnrichmentEnrichService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type CompanyEnrichmentService 

type CompanyEnrichmentService struct {
	Options []option.RequestOption
	Enrich  *CompanyEnrichmentEnrichService
}

CompanyEnrichmentService contains methods and other services that help with interacting with the find-ai API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCompanyEnrichmentService method instead.

func NewCompanyEnrichmentService 

func NewCompanyEnrichmentService(opts ...option.RequestOption) (r *CompanyEnrichmentService)

NewCompanyEnrichmentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Error 

type Error = apierror.Error

type PeopleEnrichmentEnrichService 

type PeopleEnrichmentEnrichService struct {
	Options []option.RequestOption
}

PeopleEnrichmentEnrichService contains methods and other services that help with interacting with the find-ai API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPeopleEnrichmentEnrichService method instead.

func NewPeopleEnrichmentEnrichService 

func NewPeopleEnrichmentEnrichService(opts ...option.RequestOption) (r *PeopleEnrichmentEnrichService)

NewPeopleEnrichmentEnrichService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type PeopleEnrichmentService 

type PeopleEnrichmentService struct {
	Options []option.RequestOption
	Enrich  *PeopleEnrichmentEnrichService
}

PeopleEnrichmentService contains methods and other services that help with interacting with the find-ai API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPeopleEnrichmentService method instead.

func NewPeopleEnrichmentService 

func NewPeopleEnrichmentService(opts ...option.RequestOption) (r *PeopleEnrichmentService)

NewPeopleEnrichmentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SearchGetResponse 

type SearchGetResponse struct {
	LinkedinURL string `json:"linkedin_url,required"`
	Name        string `json:"name,required"`
	// Returned only for a person.
	Company            string                               `json:"company"`
	CriteriaAndReasons []SearchGetResponseCriteriaAndReason `json:"criteria_and_reasons"`
	// Returned only for a company.
	Domain string `json:"domain"`
	// Returned only for a person.
	Title string                `json:"title"`
	JSON  searchGetResponseJSON `json:"-"`
}

func (*SearchGetResponse) UnmarshalJSON 

func (r *SearchGetResponse) UnmarshalJSON(data []byte) (err error)

type SearchGetResponseCriteriaAndReason 

type SearchGetResponseCriteriaAndReason struct {
	// Match criteria
	Criteria string `json:"criteria"`
	// Whether it's a match
	Match bool `json:"match"`
	// Reason for the match
	Reason string                                 `json:"reason"`
	JSON   searchGetResponseCriteriaAndReasonJSON `json:"-"`
}

func (*SearchGetResponseCriteriaAndReason) UnmarshalJSON 

func (r *SearchGetResponseCriteriaAndReason) UnmarshalJSON(data []byte) (err error)

type SearchNewParams 

type SearchNewParams struct {
	// The maximum number of results to return. optional for result_mode exact
	MaxMatches param.Field[float64] `json:"max_matches"`
	// Search query.
	Query param.Field[string] `json:"query"`
	// The mode of the search. Valid values are 'exact' or 'best'.
	ResultMode param.Field[SearchNewParamsResultMode] `json:"result_mode"`
	// The scope of the search. Valid values are 'person' or 'company'.
	Scope param.Field[SearchNewParamsScope] `json:"scope"`
}

func (SearchNewParams) MarshalJSON 

func (r SearchNewParams) MarshalJSON() (data []byte, err error)

type SearchNewParamsResultMode 

type SearchNewParamsResultMode string

The mode of the search. Valid values are 'exact' or 'best'. 

const (
	SearchNewParamsResultModeExact SearchNewParamsResultMode = "exact"
	SearchNewParamsResultModeBest  SearchNewParamsResultMode = "best"
)

func (SearchNewParamsResultMode) IsKnown 

func (r SearchNewParamsResultMode) IsKnown() bool

type SearchNewParamsScope 

type SearchNewParamsScope string

The scope of the search. Valid values are 'person' or 'company'. 

const (
	SearchNewParamsScopePerson  SearchNewParamsScope = "person"
	SearchNewParamsScopeCompany SearchNewParamsScope = "company"
)

func (SearchNewParamsScope) IsKnown 

func (r SearchNewParamsScope) IsKnown() bool

type SearchNewResponse 

type SearchNewResponse struct {
	Poll SearchNewResponsePoll `json:"poll,required"`
	JSON searchNewResponseJSON `json:"-"`
}

func (*SearchNewResponse) UnmarshalJSON 

func (r *SearchNewResponse) UnmarshalJSON(data []byte) (err error)

type SearchNewResponsePoll 

type SearchNewResponsePoll struct {
	Token string                    `json:"token,required"`
	Path  string                    `json:"path,required"`
	JSON  searchNewResponsePollJSON `json:"-"`
}

func (*SearchNewResponsePoll) UnmarshalJSON 

func (r *SearchNewResponsePoll) UnmarshalJSON(data []byte) (err error)

type SearchService 

type SearchService struct {
	Options []option.RequestOption
}

SearchService contains methods and other services that help with interacting with the find-ai API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSearchService method instead.

func NewSearchService 

func NewSearchService(opts ...option.RequestOption) (r *SearchService)

NewSearchService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SearchService) Get 

func (r *SearchService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *[]SearchGetResponse, err error)

The endpoint to poll to check the latest results of a search.

func (*SearchService) New 

func (r *SearchService) New(ctx context.Context, body SearchNewParams, opts ...option.RequestOption) (res *SearchNewResponse, err error)

Starts a search.

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
param
requestconfig
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.