Dokumentacja dla programistów
Inne typy
Dokumentacja API (rdzeń)Dokumentacja API
Interfejsy API monday.com do artykułów umożliwiają tworzenie, publikowanie, wyszukiwanie i usuwanie artykułów z bazy wiedzy.
Poniższe typy są zwracane przez zapytania i mutacje związane z artykułami (oraz powiązane interfejsy API). Nie można ich niezależnie odpytywać na poziomie głównym.
ArticleMetadata
Metadane artykułu z bazy wiedzy: identyfikatory, widoczność, lokalizacja, stan cyklu życia i osoby.
| Field | Type | Description |
|---|---|---|
object_id |
ID |
Identyfikator obiektu artykułu. |
name |
String |
Wyświetlana nazwa artykułu. |
privacy_kind |
PrivacyKind |
Poziom widoczności (na przykład PRIVATE lub PUBLIC). |
workspace_id |
ID |
Obszar roboczy, w którym znajduje się artykuł. |
folder_id |
ID |
Folder, w którym znajduje się artykuł, jeśli został przypisany. |
state |
String |
Stan cyklu życia artykułu (na przykład wersja robocza lub opublikowana). |
owners |
- | Użytkownicy i zespoły będący właścicielami artykułu. |
subscribers |
- | Użytkownicy i zespoły obserwujący artykuł, gdy jest on prywatny. |
KnowledgeBaseAnswer
Wynik zapytania knowledge_base_search: odpowiedź wygenerowana przez AI oraz surowe fragmenty, na których ją oparto.
| Field | Type | Description |
|---|---|---|
answer |
String |
Wygenerowana treść odpowiedzi. |
raw_snippets |
[SnippetSearchResult] |
Pasujące fragmenty źródłowe z bazy wiedzy. |
SnippetSearchResult
Pojedynczy fragment zwracany w polu KnowledgeBaseAnswer.raw_snippets.
| Field | Type | Description |
|---|---|---|
id |
String |
Identyfikator fragmentu. |
title |
String |
Tytuł lub nagłówek źródła fragmentu. |
text |
String |
Treść fragmentu. |
parent_id |
String |
Identyfikator obiektu nadrzędnego lub fragmentu, jeśli dotyczy. |
distance |
Float |
Wynik trafności z wyszukiwania wektorowego (niższy wynik często oznacza większe podobieństwo). |
url |
String |
Link do źródła w produkcie, jeśli jest dostępny. |
AppDocumentationAiResponse
Zwracany przez zapytanie ask_developer_docs (AI dokumentacji dla deweloperów). Nie dotyczy konkretnie artykułów z bazy wiedzy, ale wykorzystuje ten sam schemat odpowiedzi AI.
| Field | Type | Description |
|---|---|---|
id |
String |
Identyfikator tej odpowiedzi. |
question |
String |
Zadane pytanie. |
answer |
String |
Wygenerowana odpowiedź. |
conversation_id |
String |
Identyfikator rozmowy używany przy pytaniach uzupełniających w tym samym wątku. |