diff --git a/README.md b/README.md
index b41f40c..ed3e5b8 100644
--- a/README.md
+++ b/README.md
@@ -25,12 +25,12 @@ import Groq from 'groq-sdk';
const groq = new Groq();
async function main() {
- const completionCreateResponse = await groq.chat.completions.create({
+ const chatCompletion = await groq.chat.completions.create({
messages: [{ role: 'user', content: 'Explain the importance of low latency LLMs' }],
model: 'mixtral-8x7b-32768',
});
- console.log(completionCreateResponse.choices[0].message.content);
+ console.log(chatCompletion.choices[0].message.content);
}
main();
@@ -54,9 +54,7 @@ async function main() {
],
model: 'mixtral-8x7b-32768',
};
- const completionCreateResponse: Groq.Chat.CompletionCreateResponse = await groq.chat.completions.create(
- params,
- );
+ const chatCompletion: Groq.Chat.ChatCompletion = await groq.chat.completions.create(params);
}
main();
@@ -73,7 +71,7 @@ a subclass of `APIError` will be thrown:
```ts
async function main() {
- const completionCreateResponse = await groq.chat.completions
+ const chatCompletion = await groq.chat.completions
.create({
messages: [
{ role: 'system', content: 'You are a helpful assistant.' },
@@ -174,7 +172,7 @@ const response = await groq.chat.completions
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object
-const { data: completionCreateResponse, response: raw } = await groq.chat.completions
+const { data: chatCompletion, response: raw } = await groq.chat.completions
.create({
messages: [
{ role: 'system', content: 'You are a helpful assistant.' },
@@ -184,7 +182,7 @@ const { data: completionCreateResponse, response: raw } = await groq.chat.comple
})
.withResponse();
console.log(raw.headers.get('X-My-Header'));
-console.log(completionCreateResponse.id);
+console.log(chatCompletion.id);
```
### Making custom/undocumented requests
diff --git a/api.md b/api.md
index ba6b3ba..74dff99 100644
--- a/api.md
+++ b/api.md
@@ -15,11 +15,11 @@ Methods:
Types:
-- CompletionCreateResponse
+- ChatCompletion
Methods:
-- client.chat.completions.create({ ...params }) -> CompletionCreateResponse
+- client.chat.completions.create({ ...params }) -> ChatCompletion
# Audio
@@ -49,11 +49,11 @@ Methods:
Types:
-- ModelRetrieveResponse
-- ModelListResponse
+- Model
+- ModelList
Methods:
-- client.models.retrieve(model) -> ModelRetrieveResponse
-- client.models.list() -> ModelListResponse
+- client.models.retrieve(model) -> Model
+- client.models.list() -> ModelList
- client.models.delete(model) -> void
diff --git a/src/index.ts b/src/index.ts
index b63687b..101d2a5 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -201,8 +201,8 @@ export namespace Groq {
export import Audio = API.Audio;
export import Models = API.Models;
- export import ModelRetrieveResponse = API.ModelRetrieveResponse;
- export import ModelListResponse = API.ModelListResponse;
+ export import Model = API.Model;
+ export import ModelList = API.ModelList;
}
export default Groq;
diff --git a/src/resources/chat/chat.ts b/src/resources/chat/chat.ts
index bb465bd..9832f09 100644
--- a/src/resources/chat/chat.ts
+++ b/src/resources/chat/chat.ts
@@ -9,6 +9,6 @@ export class Chat extends APIResource {
export namespace Chat {
export import Completions = CompletionsAPI.Completions;
- export import CompletionCreateResponse = CompletionsAPI.CompletionCreateResponse;
+ export import ChatCompletion = CompletionsAPI.ChatCompletion;
export import CompletionCreateParams = CompletionsAPI.CompletionCreateParams;
}
diff --git a/src/resources/chat/completions.ts b/src/resources/chat/completions.ts
index ac625fb..521c74e 100644
--- a/src/resources/chat/completions.ts
+++ b/src/resources/chat/completions.ts
@@ -8,16 +8,13 @@ export class Completions extends APIResource {
/**
* Creates a model response for the given chat conversation.
*/
- create(
- body: CompletionCreateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ create(body: CompletionCreateParams, options?: Core.RequestOptions): Core.APIPromise {
return this._client.post('/openai/v1/chat/completions', { body, ...options });
}
}
-export interface CompletionCreateResponse {
- choices: Array;
+export interface ChatCompletion {
+ choices: Array;
id?: string;
@@ -29,10 +26,10 @@ export interface CompletionCreateResponse {
system_fingerprint?: string;
- usage?: CompletionCreateResponse.Usage;
+ usage?: ChatCompletion.Usage;
}
-export namespace CompletionCreateResponse {
+export namespace ChatCompletion {
export interface Choice {
finish_reason: string;
@@ -578,6 +575,6 @@ export namespace CompletionCreateParams {
}
export namespace Completions {
- export import CompletionCreateResponse = CompletionsAPI.CompletionCreateResponse;
+ export import ChatCompletion = CompletionsAPI.ChatCompletion;
export import CompletionCreateParams = CompletionsAPI.CompletionCreateParams;
}
diff --git a/src/resources/chat/index.ts b/src/resources/chat/index.ts
index 62f77a8..eccaa36 100644
--- a/src/resources/chat/index.ts
+++ b/src/resources/chat/index.ts
@@ -1,4 +1,4 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
export { Chat } from './chat';
-export { CompletionCreateResponse, CompletionCreateParams, Completions } from './completions';
+export { ChatCompletion, CompletionCreateParams, Completions } from './completions';
diff --git a/src/resources/index.ts b/src/resources/index.ts
index 73fe540..4de7c90 100644
--- a/src/resources/index.ts
+++ b/src/resources/index.ts
@@ -3,4 +3,4 @@
export { Audio } from './audio/audio';
export { Chat } from './chat/chat';
export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
-export { ModelRetrieveResponse, ModelListResponse, Models } from './models';
+export { Model, ModelList, Models } from './models';
diff --git a/src/resources/models.ts b/src/resources/models.ts
index 60586a7..dcab33f 100644
--- a/src/resources/models.ts
+++ b/src/resources/models.ts
@@ -8,14 +8,14 @@ export class Models extends APIResource {
/**
* Get a specific model
*/
- retrieve(model: string, options?: Core.RequestOptions): Core.APIPromise {
+ retrieve(model: string, options?: Core.RequestOptions): Core.APIPromise {
return this._client.get(`/openai/v1/models/${model}`, options);
}
/**
* get all available models
*/
- list(options?: Core.RequestOptions): Core.APIPromise {
+ list(options?: Core.RequestOptions): Core.APIPromise {
return this._client.get('/openai/v1/models', options);
}
@@ -30,7 +30,7 @@ export class Models extends APIResource {
}
}
-export interface ModelRetrieveResponse {
+export interface Model {
id?: string;
created?: number;
@@ -40,25 +40,13 @@ export interface ModelRetrieveResponse {
owned_by?: string;
}
-export interface ModelListResponse {
- data?: Array;
+export interface ModelList {
+ data?: Array;
object?: string;
}
-export namespace ModelListResponse {
- export interface Data {
- id?: string;
-
- created?: number;
-
- object?: string;
-
- owned_by?: string;
- }
-}
-
export namespace Models {
- export import ModelRetrieveResponse = ModelsAPI.ModelRetrieveResponse;
- export import ModelListResponse = ModelsAPI.ModelListResponse;
+ export import Model = ModelsAPI.Model;
+ export import ModelList = ModelsAPI.ModelList;
}