Completes json_parser.

Author: szabosteve

specification/inference/_types/CommonTypes.ts

@@ -825,21 +825,97 @@ export class CustomResponseParams {
    * For example:
    * ```
    * # text_embedding
+   * # For a response like this:
+   * 
+   * {
+   *  "object": "list",
+   *  "data": [
+   *      {
+   *        "object": "embedding",
+   *        "index": 0,
+   *        "embedding": [
+   *            0.014539449,
+   *            -0.015288644
+   *        ]
+   *      }
+   *  ],
+   *  "model": "text-embedding-ada-002-v2",
+   *  "usage": {
+   *      "prompt_tokens": 8,
+   *      "total_tokens": 8
+   *  }
+   * }
+   * 
+   * # the json_parser definition should look like this:
+   * 
    * "response":{
    *   "json_parser":{
-   *     "text_embeddings":"$.result.embeddings[*].embedding"
+   *     "text_embeddings":"$.data[*].embedding[*]"
    *   }
    * }
    *
    * # sparse_embedding
+   * # For a response like this:
+   * 
+   * {
+   *   "request_id": "75C50B5B-E79E-4930-****-F48DBB392231",
+   *   "latency": 22,
+   *   "usage": {
+   *      "token_count": 11
+   *   },
+   *   "result": {
+   *      "sparse_embeddings": [
+   *         {
+   *           "index": 0,
+   *           "embedding": [
+   *             {
+   *               "token_id": 6,
+   *               "weight": 0.101
+   *             },
+   *             {
+   *               "token_id": 163040,
+   *               "weight": 0.28417
+   *             }
+   *           ]
+   *         }
+   *      ]
+   *   }
+   * }
+   * 
+   * # the json_parser definition should look like this:
+   * 
    * "response":{
    *   "json_parser":{
-   *     "token_path":"$.result[*].embeddings[*].token",
-   *     "weight_path":"$.result[*].embeddings[*].weight"
+   *     "token_path":"$.result.sparse_embeddings[*].embedding[*].token_id",
+   *     "weight_path":"$.result.sparse_embeddings[*].embedding[*].weight"
    *   }
    * }
    *
    * # rerank
+   * # For a response like this:
+   * 
+   * {
+   *   "results": [
+   *     {
+   *       "index": 3,
+   *       "relevance_score": 0.999071,
+   *       "document": "abc"
+   *     },
+   *     {
+   *       "index": 4,
+   *       "relevance_score": 0.7867867,
+   *       "document": "123"
+   *     },
+   *     {
+   *       "index": 0,
+   *       "relevance_score": 0.32713068,
+   *       "document": "super"
+   *     }
+   *   ],
+   * }
+   * 
+   * # the json_parser definition should look like this: 
+   * 
    * "response":{
    *   "json_parser":{
    *     "reranked_index":"$.result.scores[*].index",    // optional
@@ -849,9 +925,33 @@ export class CustomResponseParams {
    * }
    *
    * # completion
+   * # For a response like this:
+   * 
+   * {
+   *  "id": "chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT",
+   *  "object": "chat.completion",
+   *  "created": 1741569952,
+   *  "model": "gpt-4.1-2025-04-14",
+   *  "choices": [
+   *    {
+   *     "index": 0,
+   *     "message": {
+   *       "role": "assistant",
+   *       "content": "Hello! How can I assist you today?",
+   *       "refusal": null,
+   *       "annotations": []
+   *     },
+   *     "logprobs": null,
+   *     "finish_reason": "stop"
+   *   }
+   *  ]
+   * }
+   * 
+   * # the json_parser definition should look like this:
+   * 
    * "response":{
    *   "json_parser":{
-   *     "completion_result":"$.result.text"
+   *     "completion_result":"$.choices[*].message.content"
    *   }
    * }
    */