action namsor_corridor {
  label: "[USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)"
  provider: namsor
  method: GET
  path: "/api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}"
  encoding: json
  input: {
    type: "object"
    properties: {
      countryIso2From: {
        type: "string"
      }
      countryIso2To: {
        type: "string"
      }
      firstNameFrom: {
        type: "string"
      }
      firstNameTo: {
        type: "string"
      }
      lastNameFrom: {
        type: "string"
      }
      lastNameTo: {
        type: "string"
      }
    }
    required: ["countryIso2From", "countryIso2To", "firstNameFrom", "firstNameTo", "lastNameFrom", "lastNameTo"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Represent multiple classifications for corridor sender and receiver (gender, country, origin, diaspora)"
    properties: {
      FirstLastNameDiasporaedOut: {
        type: "object"
        description: "Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence."
        properties: {
          countryIso2: {
            type: "string"
            description: "From input data, the countryIso2 of geographic context (US,CA etc.)"
          }
          ethnicitiesTop: {
            type: "array"
            description: "List most likely ethnicities (top 10)"
            items: {
              type: "string"
              description: "List most likely ethnicities (top 10)"
            }
          }
          ethnicity: {
            type: "string"
            description: "The most likely ethnicity"
          }
          ethnicityAlt: {
            type: "string"
            description: "The second best alternative ethnicity"
          }
          firstName: {
            type: "string"
            description: "The first name (also known as given name)"
          }
          id: {
            type: "string"
          }
          lastName: {
            type: "string"
            description: "The last name (also known as family name, or surname)"
          }
          lifted: {
            type: "boolean"
            description: "Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true."
          }
          probabilityAltCalibrated: {
            type: "number"
            format: "double"
            description: "The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating. "
          }
          probabilityCalibrated: {
            type: "number"
            format: "double"
            description: "The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating. "
          }
          score: {
            type: "number"
            format: "double"
            description: "Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. "
          }
          script: {
            type: "string"
          }
        }
      }
      FirstLastNameGenderedOut: {
        type: "object"
        description: "Represents the output of inferring the LIKELY gender from a personal name."
        properties: {
          firstName: {
            type: "string"
            description: "The first name (also known as given name)"
          }
          genderScale: {
            type: "number"
            format: "double"
            description: "Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value."
          }
          id: {
            type: "string"
          }
          lastName: {
            type: "string"
            description: "The last name (also known as family name, or surname)"
          }
          likelyGender: {
            type: "string"
            description: "Most likely gender"
            enum: ["male", "female", "unknown"]
          }
          probabilityCalibrated: {
            type: "number"
            format: "double"
            description: "The calibrated probability for inferred gender to have been guessed correctly. -1 = still calibrating. "
          }
          score: {
            type: "number"
            format: "double"
            description: "Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. "
          }
          script: {
            type: "string"
          }
        }
      }
      FirstLastNameOriginedOut: {
        type: "object"
        description: "Represents the output of inferring the LIKELY country of Origin from a personal name."
        properties: {
          countriesOriginTop: {
            type: "array"
            description: "List countries of Origin (top 10)"
            items: {
              type: "string"
              description: "List countries of Origin (top 10)"
            }
          }
          countryOrigin: {
            type: "string"
            description: "Most likely country of Origin"
          }
          countryOriginAlt: {
            type: "string"
            description: "Second best alternative : country of Origin"
          }
          firstName: {
            type: "string"
            description: "The first name (also known as given name)"
          }
          id: {
            type: "string"
          }
          lastName: {
            type: "string"
            description: "The last name (also known as family name, or surname)"
          }
          probabilityAltCalibrated: {
            type: "number"
            format: "double"
            description: "The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. -1 = still calibrating. "
          }
          probabilityCalibrated: {
            type: "number"
            format: "double"
            description: "The calibrated probability for countryOrigin to have been guessed correctly. -1 = still calibrating. "
          }
          regionOrigin: {
            type: "string"
            description: "Most likely region of Origin (based on countryOrigin ISO2 code)"
          }
          score: {
            type: "number"
            format: "double"
            description: "Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. "
          }
          script: {
            type: "string"
          }
          subRegionOrigin: {
            type: "string"
            description: "Most likely sub region of Origin (based on countryOrigin ISO2 code)"
          }
          topRegionOrigin: {
            type: "string"
            description: "Most likely top region of Origin (based on countryOrigin ISO2 code)"
          }
        }
      }
      id: {
        type: "string"
      }
      script: {
        type: "string"
      }
    }
  }
}