Skip to content

get_data_source

Operation

get_data_source

get_data_source(request: GetDataSourceInput | GetDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataSourceInputDict]) -> GetDataSourceOutput

Gets information about a data source.

Parameters:

Name Type Description Default
request GetDataSourceInput | GetDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataSourceOutput

An instance of GetDataSourceOutput.

get_data_source async

get_data_source(request: GetDataSourceInput | GetDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataSourceInputDict]) -> GetDataSourceOutput

Gets information about a data source.

Parameters:

Name Type Description Default
request GetDataSourceInput | GetDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataSourceOutput

An instance of GetDataSourceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetDataSourceInputDict

Bases: TypedDict

Dictionary form of GetDataSourceInput.

Attributes

data_source_id instance-attribute
data_source_id: Required[str]

The unique identifier of the data source.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base for the data source.

GetDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for GetDataSourceInput structure.

Attributes

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The unique identifier of the data source.

knowledge_base_id class-attribute instance-attribute
knowledge_base_id: str | None = ...

The unique identifier of the knowledge base for the data source.

Output

GetDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for GetDataSourceOutput structure.

Attributes

data_source instance-attribute
data_source: DataSource

Contains details about the data source.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.