---
sidebar:
  label: roboto.query.client
  order: 1
title: roboto.query.client
---
## Module Contents

### Query

```python
type roboto.query.client.Query = typing.Union[RoboQLQuery, QuerySpecification]
```

`from roboto.query import Query`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L26-L26)

### QueryClient

```python
class roboto.query.client.QueryClient(
    roboto_client: Optional[roboto.http.RobotoClient] = None,
    owner_org_id: Optional[str] = None,
    roboto_profile: Optional[str] = None,
)
```

`from roboto.query import QueryClient`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L29-L188)

A low-level Roboto query client. Prefer `RobotoSearch` for a simpler, more curated query interface.

**Parameters**

- **roboto_client** (`Optional[roboto.http.RobotoClient]`)
- **owner_org_id** (`Optional[str]`)
- **roboto_profile** (`Optional[str]`)

**Properties**

- **QueryClient.roboto_client** (`roboto.http.RobotoClient`)

#### QueryClient.are_query_results_available()

```python
def are_query_results_available(
    query_id: str,
    owner_org_id: Optional[str] = None,
) -> bool
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L56-L57)

**Parameters**

- **query_id** (`str`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `bool`

#### QueryClient.get_query_record()

```python
def get_query_record(
    query_id: str,
    owner_org_id: Optional[str] = None,
) -> roboto.query.api.QueryRecord
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L59-L61)

**Parameters**

- **query_id** (`str`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `roboto.query.api.QueryRecord`

#### QueryClient.get_query_results()

```python
def get_query_results(
    query_id: str,
    owner_org_id: Optional[str] = None,
) -> collections.abc.Generator[dict[str, Any], None, None]
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L63-L80)

**Parameters**

- **query_id** (`str`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `collections.abc.Generator[dict[str, Any], None, None]`

#### QueryClient.submit_query()

```python
def submit_query(
    query: Optional[Query],
    target: roboto.query.api.QueryTarget,
    timeout_seconds: float,
    content_mode: roboto.query.api.QueryContentMode = QueryContentMode.RecordWithMeta,
    owner_org_id: Optional[str] = None,
) -> collections.abc.Generator[dict[str, Any], None, None]
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L82-L104)

**Parameters**

- **query** (`Optional[Query]`)
- **target** (`roboto.query.api.QueryTarget`)
- **timeout_seconds** (`float`)
- **content_mode** (`roboto.query.api.QueryContentMode`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `collections.abc.Generator[dict[str, Any], None, None]`

#### QueryClient.submit_roboql()

```python
def submit_roboql(
    request: roboto.query.api.SubmitRoboqlQueryRequest,
    owner_org_id: Optional[str] = None,
) -> roboto.query.api.QueryRecord
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L106-L116)

**Parameters**

- **request** (`roboto.query.api.SubmitRoboqlQueryRequest`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `roboto.query.api.QueryRecord`

#### QueryClient.submit_roboql_and_await_results()

```python
def submit_roboql_and_await_results(
    request: roboto.query.api.SubmitRoboqlQueryRequest,
    timeout_seconds: float,
    owner_org_id: Optional[str] = None,
) -> collections.abc.Generator[dict[str, Any], None, None]
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L118-L133)

**Parameters**

- **request** (`roboto.query.api.SubmitRoboqlQueryRequest`)
- **timeout_seconds** (`float`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `collections.abc.Generator[dict[str, Any], None, None]`

#### QueryClient.submit_structured()

```python
def submit_structured(
    request: roboto.query.api.SubmitStructuredQueryRequest,
    owner_org_id: Optional[str] = None,
) -> roboto.query.api.QueryRecord
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L135-L145)

**Parameters**

- **request** (`roboto.query.api.SubmitStructuredQueryRequest`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `roboto.query.api.QueryRecord`

#### QueryClient.submit_structured_and_await_results()

```python
def submit_structured_and_await_results(
    request: roboto.query.api.SubmitStructuredQueryRequest,
    timeout_seconds: float,
    owner_org_id: Optional[str] = None,
) -> collections.abc.Generator[dict[str, Any], None, None]
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L147-L162)

**Parameters**

- **request** (`roboto.query.api.SubmitStructuredQueryRequest`)
- **timeout_seconds** (`float`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `collections.abc.Generator[dict[str, Any], None, None]`

#### QueryClient.submit_term()

```python
def submit_term(
    request: roboto.query.api.SubmitTermQueryRequest,
    owner_org_id: Optional[str] = None,
) -> roboto.query.api.QueryRecord
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L164-L171)

**Parameters**

- **request** (`roboto.query.api.SubmitTermQueryRequest`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `roboto.query.api.QueryRecord`

#### QueryClient.submit_term_and_await_results()

```python
def submit_term_and_await_results(
    request: roboto.query.api.SubmitTermQueryRequest,
    timeout_seconds: float = math.inf,
    owner_org_id: Optional[str] = None,
) -> collections.abc.Generator[dict[str, Any], None, None]
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L173-L188)

**Parameters**

- **request** (`roboto.query.api.SubmitTermQueryRequest`)
- **timeout_seconds** (`float`)
- **owner_org_id** (`Optional[str]`)

**Returns**

- `collections.abc.Generator[dict[str, Any], None, None]`

### RoboQLQuery

```python
type roboto.query.client.RoboQLQuery = str
```

`from roboto.query.client import RoboQLQuery`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/query/client.py#L25-L25)