StarmindClient
Attributes
module-attribute
Classes
dataclass
dataclass
FindExpertsResponse(*, experts: Optional[List[Dict[str, Any]]] = None, label_matches: Optional[List[ConceptLabelMatch | Mapping[str, Any]]] = None)
Response for Find experts
Attributes
class-attribute
instance-attribute
List of experts matching the search query. May be empty if no experts are found.
dataclass
FindQuestionsResponse(*, links: Optional[Dict[str, Any]] = None, items: Optional[List[Question | Mapping[str, Any]]] = None, total: Optional[int] = None)
dataclass
dataclass
PostQuestionDraftInput(title: str, *, category: Optional[int] = None, description: Optional[str] = None, language: Optional[Language] = None, knowledge_space: Optional[int] = None)
Create a question draft
Attributes
class-attribute
instance-attribute
The optional id of the category to assign the question draft to
instance-attribute
Question title, Between 4 and 100 characters by default. Depending on the network configuration the title max length may be limited or extended further.
class-attribute
instance-attribute
The optional question description providing detailed context and information about the question. Depending on the network configuration the description might be enforced to be non-empty.
dataclass
Question(*, knowledge_space_id: Optional[int] = None, upvote_count: Optional[int] = None, view_count: Optional[int] = None, published: Optional[str] = None, is_deleted: Optional[bool] = None, title: Optional[str] = None, last_activity: Optional[str] = None, is_published: Optional[bool] = None, created: Optional[str] = None, description: Optional[str] = None, solution_count: Optional[int] = None, content_updated: Optional[str] = None, id: Optional[int] = None, updated: Optional[str] = None, language: Optional[str] = None)
Response for Create a question draft
Attributes
class-attribute
instance-attribute
The unique knowledge space id to which the question belongs.
class-attribute
instance-attribute
The total number of upvotes the question has received.
class-attribute
instance-attribute
The number of times the question has been viewed by users.
class-attribute
instance-attribute
Timestamp indicating when the question was published (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Indicates if the question is deleted. Deleted questions are not visible to users, but can still be accessed by the administrators.
class-attribute
instance-attribute
The question title
class-attribute
instance-attribute
Timestamp indicating the last activity with the question (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
The question is_published flag indicates whether the question is published or not. A published solution is visible to all users, while an unpublished solution is in draft state only visible to the author.
class-attribute
instance-attribute
Timestamp indicating when the question was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Question description providing detailed context and information about the question
class-attribute
instance-attribute
This is the number of solutions that have been provided for this question.
class-attribute
instance-attribute
Timestamp indicating when the question's content or attachments were last updated (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
The unique question id
class-attribute
instance-attribute
Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates.
dataclass
dataclass
QuestionComplete(*, knowledge_space_id: Optional[int] = None, upvote_count: Optional[int] = None, view_count: Optional[int] = None, published: Optional[str] = None, is_deleted: Optional[bool] = None, title: Optional[str] = None, last_activity: Optional[str] = None, is_published: Optional[bool] = None, created: Optional[str] = None, description: Optional[str] = None, solution_count: Optional[int] = None, content_updated: Optional[str] = None, id: Optional[int] = None, updated: Optional[str] = None, language: Optional[str] = None, source: Optional[str] = None, concepts: Optional[List[ConceptLabelMatch | Mapping[str, Any]]] = None, knowledge_space: Optional[KnowledgeSpace | Mapping[str, Any]] = None, solutions: Optional[List[Solution | Mapping[str, Any]]] = None, attachments: Optional[List[Attachment | Mapping[str, Any]]] = None, comments: Optional[List[Comment | Mapping[str, Any]]] = None)
Definition: QuestionComplete
Attributes
class-attribute
instance-attribute
The unique knowledge space id to which the question belongs.
class-attribute
instance-attribute
The total number of upvotes the question has received.
class-attribute
instance-attribute
The number of times the question has been viewed by users.
class-attribute
instance-attribute
Timestamp indicating when the question was published (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Indicates if the question is deleted. Deleted questions are not visible to users, but can still be accessed by the administrators.
class-attribute
instance-attribute
The question title
class-attribute
instance-attribute
Timestamp indicating the last activity with the question (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
The question is_published flag indicates whether the question is published or not. A published solution is visible to all users, while an unpublished solution is in draft state only visible to the author.
class-attribute
instance-attribute
Timestamp indicating when the question was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Question description providing detailed context and information about the question
class-attribute
instance-attribute
This is the number of solutions that have been provided for this question.
class-attribute
instance-attribute
Timestamp indicating when the question's content or attachments were last updated (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
The unique question id
class-attribute
instance-attribute
Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates.
class-attribute
instance-attribute
The question language
class-attribute
instance-attribute
source
class-attribute
instance-attribute
concepts: Optional[List[ConceptLabelMatch | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The assigned question concepts
class-attribute
instance-attribute
knowledge_space: Optional[KnowledgeSpace | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)
The assigned question knowledge space
class-attribute
instance-attribute
solutions: Optional[List[Solution | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The question solutions
dataclass
ConceptLabelMatch(*, concept_id: Optional[str] = None, description: Optional[str] = None, is_flat: Optional[bool] = None, label_match: Optional[str] = None, language: Optional[str] = None, ontology_id: Optional[str] = None, primary_label: Optional[str] = None)
Definition: ConceptLabelMatch
Attributes
class-attribute
instance-attribute
The unique concept id
class-attribute
instance-attribute
The concept description
class-attribute
instance-attribute
is_flat
class-attribute
instance-attribute
The label that matched the concept
class-attribute
instance-attribute
Concept language
class-attribute
instance-attribute
The unique ontology id to which the concept belongs
dataclass
Attachment(*, created: Optional[str] = None, hash: Optional[str] = None, id: Optional[int] = None, link: Optional[str] = None, mime_type: Optional[str] = None, name: Optional[str] = None, size: Optional[int] = None)
Definition: Attachment
Attributes
class-attribute
instance-attribute
Timestamp indicating when the attachment was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
The attachment hash
class-attribute
instance-attribute
the unique attachment id
class-attribute
instance-attribute
The relative url to the attachment resource
class-attribute
instance-attribute
The attachment file mime_type
class-attribute
instance-attribute
The attachment file name
dataclass
Comment(*, content_updated: Optional[str] = None, created: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, language: Optional[str] = None, updated: Optional[str] = None, upvote_count: Optional[int] = None, user: Optional[UserLegacy | Mapping[str, Any]] = None)
Definition: Comment
Attributes
class-attribute
instance-attribute
Timestamp indicating when the comment's description was last updated (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Timestamp indicating when the comment was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
This is the main text of the comment that provides additional information or context to the question or solution.
class-attribute
instance-attribute
The unique comment id
class-attribute
instance-attribute
The comment language
class-attribute
instance-attribute
Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates.
dataclass
Solution(*, accepted_by_question_poser: Optional[str] = None, attachments: Optional[List[Attachment | Mapping[str, Any]]] = None, comments: Optional[List[Comment | Mapping[str, Any]]] = None, content_updated: Optional[str] = None, created: Optional[str] = None, description: Optional[str] = None, expires: Optional[str] = None, id: Optional[int] = None, is_published: Optional[bool] = None, language: Optional[str] = None, published: Optional[str] = None, rating_count: Optional[int] = None, solution_authority_approval: Optional[SolutionAuthorityApproval | Mapping[str, Any]] = None, updated: Optional[str] = None, upvote_count: Optional[int] = None, user: Optional[UserLegacy | Mapping[str, Any]] = None, validated: Optional[SolutionValidation | Mapping[str, Any]] = None, validity_period: Optional[str] = None)
Definition: Solution
Attributes
class-attribute
instance-attribute
Timestamp indicating whether the solution has been accepted by the question poser (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
attachments: Optional[List[Attachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The solution attachments
class-attribute
instance-attribute
The solution comments
class-attribute
instance-attribute
Timestamp indicating when the solution's content was last updated (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Timestamp indicating when the solution was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
This is the main text of the solution that provides the answer or guidance to the question posed.
class-attribute
instance-attribute
Timestamp indicating when the solution is about to expiry and requires revalidation (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
the unique solution id
class-attribute
instance-attribute
The solution is_published flag indicates whether the solution is published or not. A published solution is visible to all users.
class-attribute
instance-attribute
The solution language
class-attribute
instance-attribute
Timestamp indicating when the solution was published (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Total number of ratings for the solution.
class-attribute
instance-attribute
Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates.
class-attribute
instance-attribute
The total number of upvotes the solution has received.
class-attribute
instance-attribute
The user who created the solution
dataclass
SolutionValidation(*, revalidated_at: Optional[str] = None, validity_period: Optional[str] = None, user: Optional[UserLegacy | Mapping[str, Any]] = None)
Definition: SolutionValidation
Attributes
class-attribute
instance-attribute
revalidated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'revalidatedAt'})
The date when the solution was revalidated
dataclass
SolutionAuthorityApproval(*, approval_date: Optional[str] = None, solution_authority_id: Optional[int] = None, solution_authority_name: Optional[str] = None, user: Optional[UserLegacy | Mapping[str, Any]] = None)
Definition: SolutionAuthorityApproval
Attributes
class-attribute
instance-attribute
Date of the solution authority approval (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
ID of the solution authority
dataclass
UserLegacy(*, email: Optional[str] = None, global_user_id: Optional[str] = None, image: Optional[str] = None, firstname: Optional[str] = None, lastname: Optional[str] = None)
Definition: UserLegacy
Attributes
class-attribute
instance-attribute
class-attribute
instance-attribute
global_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'globalUserId'})
global_user_id
class-attribute
instance-attribute
image
class-attribute
instance-attribute
firstname
dataclass
User(*, about: Optional[str] = None, avatar_url: Optional[str] = None, company: Optional[str] = None, country: Optional[str] = None, created: Optional[str] = None, deleted: Optional[str] = None, department: Optional[str] = None, email: Optional[str] = None, first_name: Optional[str] = None, first_seen: Optional[str] = None, id: Optional[UserId] = None, is_federated: Optional[bool] = None, is_technical: Optional[bool] = None, language: Optional[Language] = None, last_name: Optional[str] = None, location: Optional[str] = None, position: Optional[str] = None)
Definition: User
Attributes
class-attribute
instance-attribute
Custom text entered by the user to describe themselves in their 'About Me' section
class-attribute
instance-attribute
URL to the user's avatar image
class-attribute
instance-attribute
Company of the user
class-attribute
instance-attribute
ISO 3166-1 alpha-2 country code (e.g. ch, us, de) of the user
class-attribute
instance-attribute
Timestamp indicating when the user was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Timestamp indicating when the user was deleted (yyyy-MM-ddTHH:mm:ss.fffZ). Without admin permissions, only non deleted user will be returned
class-attribute
instance-attribute
Department of the user
class-attribute
instance-attribute
Email of the user
class-attribute
instance-attribute
First name of the user.
class-attribute
instance-attribute
Timestamp indicating when the user logged in the first time (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Indicates whether the user authenticates using local credentials (email/password) rather than an external SSO provider (SAML, OpenID Connect)
class-attribute
instance-attribute
Indicates whether the user is a technical API user (non-interactive/machine account); when true the user typically authenticates via API key
class-attribute
instance-attribute
The user's interface language preference
class-attribute
instance-attribute
Last name of the user.
class-attribute
instance-attribute
Location of the user
dataclass
KnowledgeSpace(*, automatic_new_user_assignment: Optional[bool] = None, created: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, is_closed: Optional[bool] = None, member_count: Optional[int] = None, name: Optional[str] = None, updated: Optional[str] = None)
Definition: KnowledgeSpace
Attributes
class-attribute
instance-attribute
Indicates if new users are automatically assigned
class-attribute
instance-attribute
Timestamp indicating when the knowledge space was created (yyyy-MM-ddTHH:mm:ss.fffZ)
class-attribute
instance-attribute
Description of the knowledge space
class-attribute
instance-attribute
The unique knowledge space id
class-attribute
instance-attribute
Indicates if the knowledge space is non public
class-attribute
instance-attribute
Number of members
class-attribute
instance-attribute
Name of the knowledge space
dataclass
GraphQLError(*, extensions: Optional[Dict[str, Any]] = None, locations: Optional[List[Dict[str, Any]]] = None, message: Optional[str] = None, path: Optional[List[str]] = None)
Definition: GraphQLError
StarmindClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for starmind connector.
Initialize a StarmindClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
find_experts(input: FindExpertsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Find experts
Finds experts based on the provided text_query. The search leverages the knowledge graph to identify users with relevant expertise and knowledge related to the query. Provide the optional language to specify the preferred language for concept label filtering. This does not affect the search matching itself; it only filters which expertise we show from returned users by selecting concepts based on the primary label in the chosen language. Returned concepts are deduplicated when multiple concepts share the same primary label.
Swagger operation ID: FindExperts_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FindExpertsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
find_questions(*, query: Optional[str] = None, limit: Optional[int] = None, filter: Optional[str] = None, sort: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Find questions
Searches questions using optional query, limit (default 10),
filter, and sort; returns a paginated collection with question
items. By default, all published questions are returned, ordered by
their last activity (descending). A combination of filters, search
queries and ordering criteria can be applied to the result.
Swagger operation ID: FindQuestions_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
query
|
Optional[str]
|
The question search query. |
None
|
limit
|
Optional[int]
|
Limit the number of returned questions. Defaults to 10. |
None
|
filter
|
Optional[str]
|
Filter the list of questions using a predefined filter. |
None
|
sort
|
Optional[str]
|
Specify the criteria the result is sorted by. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_user_by_id(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get user by id
Retrieves user information based on the provided user id.
Swagger operation ID: GetUserById_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique global user identifier (UUID) as path parameter used to reference the user across the Starmind platform. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
post_question_draft(input: PostQuestionDraftInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a question draft
Creates a new question draft. The draft is not yet searchable or answerable by others. After creation, publish the draft (via the publish endpoint) to trigger expert search, make the question discoverable, and allow other users to answer it. Providing the optional description helps experts understand the question better and increases the chances of getting high-quality answers.
Swagger operation ID: PostQuestionDraft_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PostQuestionDraftInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
publish_question_draft(question_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Publish a question
Publishes a question draft. Publishing the question triggers expert search, makes the question discoverable, and allows other users to answer it. Questions are always published anonymously.
Swagger operation ID: PublishQuestionDraft_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_id
|
int
|
The ID of the question draft to be published. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |