Body Required

• docs array[object] Required

  An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is text_field. Currently, for NLP models, only a single value is allowed.

  Hide docs attributes Show docs attributes object

  • Additional properties
  • key object
• inference_config object
  Hide inference_config attributes Show inference_config attributes object

  • regression object
    Hide regression attributes Show regression attributes object

    • results_field string

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • num_top_feature_importance_values number

      Specifies the maximum number of feature importance values per document.

  • classification object
    Hide classification attributes Show classification attributes object

    • num_top_classes number

      Specifies the number of top class predictions to return. Defaults to 0.

    • num_top_feature_importance_values number

      Specifies the maximum number of feature importance values per document.

    • prediction_field_type string

      Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

    • top_classes_results_field string

      Specifies the field to which the top classes are written. Defaults to top_classes.

  • text_classification object
    Hide text_classification attributes Show text_classification attributes object

    • num_top_classes number

      Specifies the number of top class predictions to return. Defaults to 0.

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

    • classification_labels array[string]

      Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels

  • zero_shot_classification object
    Hide zero_shot_classification attributes Show zero_shot_classification attributes object

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

    • multi_label boolean

      Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.

    • labels array[string] Required

      The labels to predict.

  • fill_mask object
    Hide fill_mask attributes Show fill_mask attributes object

    • num_top_classes number

      Specifies the number of top class predictions to return. Defaults to 0.

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

  • ner object
    Hide ner attributes Show ner attributes object

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

  • pass_through object
    Hide pass_through attributes Show pass_through attributes object

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

  • text_embedding object
    Hide text_embedding attributes Show text_embedding attributes object

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

  • text_expansion object
    Hide text_expansion attributes Show text_expansion attributes object

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

  • question_answering object
    Hide question_answering attributes Show question_answering attributes object

    • question string Required

      The question to answer given the inference context

    • num_top_classes number

      Specifies the number of top class predictions to return. Defaults to 0.

    • tokenization object
      Hide tokenization attributes Show tokenization attributes object

      • truncate string

        Values are first, second, or none.

      • span number

        Span options to apply

    • results_field string

      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

    • max_answer_length number

      The maximum answer length to consider for extraction