observation-js Documentation - v1.16.0
    Preparing search index...

    Interface NiaResponse

    The augmented response from the NIA identify proxy.

    interface NiaResponse {
        model_coverage: { image: string; description: string };
        predictions: NiaPrediction[];
        location?: string;
        location_detail?: LocationDetail;
        species?: NiaSpecies[];
        life_stages?: NiaLifeStage[];
    }
    Index

    Properties

    model_coverage predictions location? location_detail? species? life_stages?

    Properties

    model_coverage: { image: string; description: string }

    Describes the coverage of the currently active NIA model(s). Always added to successful responses.

    Type Declaration

    • image: string

      A link to an image showing the coverage visually.

    • description: string

      A textual description of the coverage.

    predictions: NiaPrediction[]

    The predictions returned by NIA.

    location?: string

    The display name of the matched location.

    Use location_detail instead. Only present when parsable coordinates are supplied.

    location_detail?: LocationDetail

    The full matched location object. Only present when parsable coordinates are supplied and within a known location.

    species?: NiaSpecies[]

    The species in the predictions. Only present when NIA replies with predictions.

    life_stages?: NiaLifeStage[]

    Life stage details for the top predicted life stage per species, when confident.

    Settings

    Member Visibility

    On This Page

    Properties