​
extract_text

def extract_text(
    self,
    element_description: str
) -> str:
​
element_description
string
required

Natural language description of the element to extract text from.

​
return
str

Extracted text string(s) within the requested element. If there are multiple, separate text chunks within the element (i.e. the element description is all financial headlines on a page), these chunks will be separated by newline characters.

​
raises
ValueError

Raises ValueError if the API request fails or if the API key is not set.