소스 검색

update docs

Bruce MacDonald 6 달 전
부모
커밋
bee4051d6d
2개의 변경된 파일10개의 추가작업 그리고 7개의 파일을 삭제
  1. 8 5
      README.md
  2. 2 2
      src/interfaces.ts

+ 8 - 5
README.md

@@ -130,15 +130,18 @@ ollama.create(request)
 - `request` `<Object>`: The request object containing create parameters.
   - `model` `<string>` The name of the model to create.
   - `from` `<string>`: The base model to derive from.
-  - `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned
+  - `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
+  - `quantize` `<string>`: Quanization precision level (`q8_0`, `q4_K_M`, etc.).
   - `template` `<string>`: (Optional) The prompt template to use with the model.
-  - `license` `<string|string[]>`: (Optional) The license(s) associated with the model
+  - `license` `<string|string[]>`: (Optional) The license(s) associated with the model.
   - `system` `<string>`: (Optional) The system prompt for the model.
-  - `parameters` `<Record<string, unknown>>`: (Optional) Additional model parameters as key-value pairs
-  - `messages` `<Message[]>`: (Optional) Initial conversation messages for the model.
-  - `adapters` `<Record<string, string>>`: (Optional) A key-value map of LoRA adapter configurations
+  - `parameters` `<Record<string, unknown>>`: (Optional) Additional model parameters as key-value pairs.
+  - `messages` `<Message[]>`: (Optional) Initial chat messages for the model.
+  - `adapters` `<Record<string, string>>`: (Optional) A key-value map of LoRA adapter configurations.
 - Returns: `<ProgressResponse>`
 
+Note: The `files` parameter is not currently supported in `ollama-js`.
+
 ### delete
 
 ```javascript

+ 2 - 2
src/interfaces.ts

@@ -120,15 +120,15 @@ export interface PushRequest {
 
 export interface CreateRequest {
   model: string
+  from?: string
   stream?: boolean
   quantize?: string
-  from?: string
-  adapters?: Record<string, string>
   template?: string
   license?: string | string[]
   system?: string
   parameters?: Record<string, unknown>
   messages?: Message[]
+  adapters?: Record<string, string>
 }
 
 export interface DeleteRequest {