Files

14 KiB

\LabelAPI

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
RiskDisposeLabels Post /v1/label/dispose Dispose of this tenant's expired assertions, whole records only
RiskHoldLabels Post /v1/label/hold Place or release a litigation hold on named records
RiskLabel Post /v1/label Assert ground truth about events
RiskLabelCoverage Get /v1/label/coverage How much of the window has matured, and how much of that is judged
RiskLabelVocabulary Get /v1/label/vocabulary The closed vocabularies and the precedence rule that resolves a conflict
RiskLabels Get /v1/label Read the assertions this tenant has recorded
RiskResolveLabels Post /v1/label/resolve Resolve the label in force for named events, as of each event's own horizon

RiskDisposeLabels

LabelRiskDisposeOut RiskDisposeLabels(ctx).LabelRiskDisposeIn(labelRiskDisposeIn).Execute()

Dispose of this tenant's expired assertions, whole records only

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	labelRiskDisposeIn := *openapiclient.NewLabelRiskDisposeIn() // LabelRiskDisposeIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskDisposeLabels(context.Background()).LabelRiskDisposeIn(labelRiskDisposeIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskDisposeLabels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskDisposeLabels`: LabelRiskDisposeOut
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskDisposeLabels`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskDisposeLabelsRequest struct via the builder pattern

Name Type Description Notes
labelRiskDisposeIn LabelRiskDisposeIn

Return type

LabelRiskDisposeOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskHoldLabels

LabelRiskHoldOut RiskHoldLabels(ctx).LabelRiskHoldIn(labelRiskHoldIn).Execute()

Place or release a litigation hold on named records

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	labelRiskHoldIn := *openapiclient.NewLabelRiskHoldIn() // LabelRiskHoldIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskHoldLabels(context.Background()).LabelRiskHoldIn(labelRiskHoldIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskHoldLabels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskHoldLabels`: LabelRiskHoldOut
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskHoldLabels`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskHoldLabelsRequest struct via the builder pattern

Name Type Description Notes
labelRiskHoldIn LabelRiskHoldIn

Return type

LabelRiskHoldOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskLabel

LabelRiskLabelOut RiskLabel(ctx).LabelRiskLabelIn(labelRiskLabelIn).Execute()

Assert ground truth about events

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	labelRiskLabelIn := *openapiclient.NewLabelRiskLabelIn() // LabelRiskLabelIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskLabel(context.Background()).LabelRiskLabelIn(labelRiskLabelIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskLabel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskLabel`: LabelRiskLabelOut
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskLabel`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskLabelRequest struct via the builder pattern

Name Type Description Notes
labelRiskLabelIn LabelRiskLabelIn

Return type

LabelRiskLabelOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskLabelCoverage

LabelRiskLabelCoverage RiskLabelCoverage(ctx).From(from).To(to).Horizon(horizon).Execute()

How much of the window has matured, and how much of that is judged

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	from := "from_example" // string | From and To bound the EVENT window, half-open, RFC 3339.  Unstated, the window is the 90 days ENDING where maturity begins — `to` is the horizon ago, not now. A default window running to now under a default horizon could not contain one matured event, so every count below it would be zero however much ground truth the tenant held. (optional)
	to := "to_example" // string |  (optional)
	horizon := int64(789) // int64 | Horizon is the maturity horizon in days the coverage is measured under. Unstated takes 120. It also moves the default window, which ends where maturity begins. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskLabelCoverage(context.Background()).From(from).To(to).Horizon(horizon).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskLabelCoverage``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskLabelCoverage`: LabelRiskLabelCoverage
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskLabelCoverage`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskLabelCoverageRequest struct via the builder pattern

Name Type Description Notes
from string From and To bound the EVENT window, half-open, RFC 3339. Unstated, the window is the 90 days ENDING where maturity begins — `to` is the horizon ago, not now. A default window running to now under a default horizon could not contain one matured event, so every count below it would be zero however much ground truth the tenant held.
to string
horizon int64 Horizon is the maturity horizon in days the coverage is measured under. Unstated takes 120. It also moves the default window, which ends where maturity begins.

Return type

LabelRiskLabelCoverage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskLabelVocabulary

LabelRiskLabelVocabulary RiskLabelVocabulary(ctx).Execute()

The closed vocabularies and the precedence rule that resolves a conflict

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskLabelVocabulary(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskLabelVocabulary``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskLabelVocabulary`: LabelRiskLabelVocabulary
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskLabelVocabulary`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiRiskLabelVocabularyRequest struct via the builder pattern

Return type

LabelRiskLabelVocabulary

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskLabels

LabelRiskLabelsOut RiskLabels(ctx).Kind(kind).Subject(subject).Source(source).From(from).To(to).Limit(limit).Execute()

Read the assertions this tenant has recorded

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	kind := "kind_example" // string | Kind and Subject narrow to one entity. (optional)
	subject := "subject_example" // string |  (optional)
	source := "source_example" // string | Source narrows to one asserter — the read that answers \"what has commerce told us\", separately from \"what has an analyst told us\". (optional)
	from := "from_example" // string | From and To bound the EVENT time, half-open, RFC 3339. (optional)
	to := "to_example" // string |  (optional)
	limit := int64(789) // int64 | Limit caps the page. Out of range takes the plane's own bound. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskLabels(context.Background()).Kind(kind).Subject(subject).Source(source).From(from).To(to).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskLabels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskLabels`: LabelRiskLabelsOut
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskLabels`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskLabelsRequest struct via the builder pattern

Name Type Description Notes
kind string Kind and Subject narrow to one entity.
subject string
source string Source narrows to one asserter — the read that answers "what has commerce told us", separately from "what has an analyst told us".
from string From and To bound the EVENT time, half-open, RFC 3339.
to string
limit int64 Limit caps the page. Out of range takes the plane's own bound.

Return type

LabelRiskLabelsOut

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RiskResolveLabels

LabelRiskResolveOut RiskResolveLabels(ctx).LabelRiskResolveIn(labelRiskResolveIn).Execute()

Resolve the label in force for named events, as of each event's own horizon

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	labelRiskResolveIn := *openapiclient.NewLabelRiskResolveIn() // LabelRiskResolveIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LabelAPI.RiskResolveLabels(context.Background()).LabelRiskResolveIn(labelRiskResolveIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LabelAPI.RiskResolveLabels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RiskResolveLabels`: LabelRiskResolveOut
	fmt.Fprintf(os.Stdout, "Response from `LabelAPI.RiskResolveLabels`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRiskResolveLabelsRequest struct via the builder pattern

Name Type Description Notes
labelRiskResolveIn LabelRiskResolveIn

Return type

LabelRiskResolveOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]