ak.str.index_in
---------------

.. py:module: ak.str.index_in

Defined in `awkward.operations.str.akstr_index_in <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_index_in.py>`__ on `line 16 <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_index_in.py#L16>`__.

.. py:function:: ak.str.index_in(array, value_set, *, skip_nones=False, highlevel=True, behavior=None, attrs=None)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param value_set: Array-like data (anything :py:obj:`ak.to_layout` recognizes), set of
                  values to search for in ``array``.
    :param skip_nones: If True, None values in ``array`` are not matched
                   against ``value_set``; otherwise, None is considered a legal value.
    :type skip_nones: bool
    :param highlevel: If True, return an :py:obj:`ak.Array`; otherwise, return
                  a low-level :py:obj:`ak.contents.Content` subclass.
    :type highlevel: bool
    :param behavior: Custom :py:obj:`ak.behavior` for the output array, if
                 high-level.
    :type behavior: None or dict
    :param attrs: Custom attributes for the output array, if
              high-level.
    :type attrs: None or dict

Returns the index of the first pattern in ``value_set`` that each string in
``array`` matches. If the string is not found within ``value_set``, then the
index is set to None.

Note: this function does not raise an error if the ``array`` does not
contain any string or bytestring data.

Requires the pyarrow library and calls
`pyarrow.compute.index_in <https://arrow.apache.org/docs/python/generated/pyarrow.compute.index_in.html>`__.