Skip to content

Instantly share code, notes, and snippets.

@henriquez
Last active April 10, 2024 21:53
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save henriquez/207650a6a45aae31308d2596e5ece01f to your computer and use it in GitHub Desktop.
Save henriquez/207650a6a45aae31308d2596e5ece01f to your computer and use it in GitHub Desktop.
SDK reference documentation data structure
// Documentation - related data model for information seeking intents
[
//
{ "codeArray": [ { serialized code block1 }, { serialized code block 2}, .. },
"pageTitle": "page title in h element and DOM page title, includes service + function + language",
"functionText": "function description..",
"language": "python",
"githubURL" : "URL..",
"functionArguments": [ { argument type 1 }, { argument type 2 }, ... ],
"return" : [ "return value1 description", ... ],
"queryOptimization" : "text used for SEO and code comment query matching",
"embeddings-ada-003": [1.5, -0.4, 7.2, 19.6, 3.1, ..., 20.2],
"embeddings-cohere": [1.5, -0.4, 7.2, 19.6, 3.1, ..., 20.2],
"embeddings-gemini": [1.5, -0.4, 7.2, 19.6, 3.1, ..., 20.2],
},
...one of the above objects for every function in the SDK
]
// Q&A related data model for bug/error/feature gap intents
[
{ "messages": Message[] // Array of forum and historical conversation
// posts and replies
"questionSummary": ".." // LLM summary of original question
"answerSummary": ".." // LLM summary of thread answer
"title": ".." // Thread title
"url": ".." // Thread URL
"status": enum // enum of thread disposition, e.g. question
// answered/accepted by user, not answered, etc
},
... one of these objects for every forum thread and devsite conversation
]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment