biocontext_kb.core.opentargets#

Functions#

get_open_targets_graphql_schema()

Retrieve the Open Targets GraphQL schema for query construction.

get_open_targets_query_examples()

Retrieve example GraphQL queries for the Open Targets API. Examples demonstrate common use cases.

query_open_targets_graphql(query_string[, variables])

Execute GraphQL queries against the Open Targets API. Use get_open_targets_query_examples() or get_open_targets_graphql_schema() first.

Package Contents#

biocontext_kb.core.opentargets.get_open_targets_graphql_schema()#

Retrieve the Open Targets GraphQL schema for query construction.

Returns:

Schema string in format {‘schema’: ‘…’} containing GraphQL type definitions or error message.

Return type:

dict

biocontext_kb.core.opentargets.get_open_targets_query_examples()#

Retrieve example GraphQL queries for the Open Targets API. Examples demonstrate common use cases.

Returns:

Example queries mapped by category (informationForTarget, drugsForTarget, associatedDiseases, etc.) with GraphQL query strings.

Return type:

dict

biocontext_kb.core.opentargets.query_open_targets_graphql(query_string, variables=None)#

Execute GraphQL queries against the Open Targets API. Use get_open_targets_query_examples() or get_open_targets_graphql_schema() first.

Returns:

GraphQL response with data field containing targets, diseases, drugs, variants, studies or error message.

Return type:

dict

Parameters:
  • query_string (Annotated[str, Field(description="GraphQL query string starting with 'query' keyword")])

  • variables (Annotated[Optional[dict], Field(description='Optional variables for the GraphQL query')])