telnyx-ai-inference-go
npx skills add https://github.com/team-telnyx/telnyx-ext-agent-skills --skill telnyx-ai-inference-go
Agent 安装分布
Skill 文档
Telnyx Ai Inference – Go
Installation
go get github.com/team-telnyx/telnyx-go
Setup
import (
"context"
"fmt"
"os"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
client := telnyx.NewClient(
option.WithAPIKey(os.Getenv("TELNYX_API_KEY")),
)
All examples below assume client is already initialized as shown above.
List conversations
Retrieve a list of all AI conversations configured by the user.
GET /ai/conversations
conversations, err := client.AI.Conversations.List(context.TODO(), telnyx.AIConversationListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", conversations.Data)
Create a conversation
Create a new AI Conversation.
POST /ai/conversations
Optional: metadata (object), name (string)
conversation, err := client.AI.Conversations.New(context.TODO(), telnyx.AIConversationNewParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", conversation.ID)
Get Insight Template Groups
Get all insight groups
GET /ai/conversations/insight-groups
page, err := client.AI.Conversations.InsightGroups.GetInsightGroups(context.TODO(), telnyx.AIConversationInsightGroupGetInsightGroupsParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Create Insight Template Group
Create a new insight group
POST /ai/conversations/insight-groups â Required: name
Optional: description (string), webhook (string)
insightTemplateGroupDetail, err := client.AI.Conversations.InsightGroups.InsightGroups(context.TODO(), telnyx.AIConversationInsightGroupInsightGroupsParams{
Name: "name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateGroupDetail.Data)
Get Insight Template Group
Get insight group by ID
GET /ai/conversations/insight-groups/{group_id}
insightTemplateGroupDetail, err := client.AI.Conversations.InsightGroups.Get(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateGroupDetail.Data)
Update Insight Template Group
Update an insight template group
PUT /ai/conversations/insight-groups/{group_id}
Optional: description (string), name (string), webhook (string)
insightTemplateGroupDetail, err := client.AI.Conversations.InsightGroups.Update(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.AIConversationInsightGroupUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateGroupDetail.Data)
Delete Insight Template Group
Delete insight group by ID
DELETE /ai/conversations/insight-groups/{group_id}
err := client.AI.Conversations.InsightGroups.Delete(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
Assign Insight Template To Group
Assign an insight to a group
POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign
err := client.AI.Conversations.InsightGroups.Insights.Assign(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.AIConversationInsightGroupInsightAssignParams{
GroupID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
},
)
if err != nil {
panic(err.Error())
}
Unassign Insight Template From Group
Remove an insight from a group
DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign
err := client.AI.Conversations.InsightGroups.Insights.DeleteUnassign(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.AIConversationInsightGroupInsightDeleteUnassignParams{
GroupID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
},
)
if err != nil {
panic(err.Error())
}
Get Insight Templates
Get all insights
GET /ai/conversations/insights
page, err := client.AI.Conversations.Insights.List(context.TODO(), telnyx.AIConversationInsightListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Create Insight Template
Create a new insight
POST /ai/conversations/insights â Required: instructions, name
Optional: json_schema (object), webhook (string)
insightTemplateDetail, err := client.AI.Conversations.Insights.New(context.TODO(), telnyx.AIConversationInsightNewParams{
Instructions: "instructions",
Name: "name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateDetail.Data)
Get Insight Template
Get insight by ID
GET /ai/conversations/insights/{insight_id}
insightTemplateDetail, err := client.AI.Conversations.Insights.Get(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateDetail.Data)
Update Insight Template
Update an insight template
PUT /ai/conversations/insights/{insight_id}
Optional: instructions (string), json_schema (object), name (string), webhook (string)
insightTemplateDetail, err := client.AI.Conversations.Insights.Update(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.AIConversationInsightUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateDetail.Data)
Delete Insight Template
Delete insight by ID
DELETE /ai/conversations/insights/{insight_id}
err := client.AI.Conversations.Insights.Delete(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
Get a conversation
Retrieve a specific AI conversation by its ID.
GET /ai/conversations/{conversation_id}
conversation, err := client.AI.Conversations.Get(context.TODO(), "conversation_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", conversation.Data)
Update conversation metadata
Update metadata for a specific conversation.
PUT /ai/conversations/{conversation_id}
Optional: metadata (object)
conversation, err := client.AI.Conversations.Update(
context.TODO(),
"conversation_id",
telnyx.AIConversationUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", conversation.Data)
Delete a conversation
Delete a specific conversation by its ID.
DELETE /ai/conversations/{conversation_id}
err := client.AI.Conversations.Delete(context.TODO(), "conversation_id")
if err != nil {
panic(err.Error())
}
Get insights for a conversation
Retrieve insights for a specific conversation
GET /ai/conversations/{conversation_id}/conversations-insights
response, err := client.AI.Conversations.GetConversationsInsights(context.TODO(), "conversation_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Create Message
Add a new message to the conversation.
POST /ai/conversations/{conversation_id}/message â Required: role
Optional: content (string), metadata (object), name (string), sent_at (date-time), tool_call_id (string), tool_calls (array[object]), tool_choice (object)
err := client.AI.Conversations.AddMessage(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.AIConversationAddMessageParams{
Role: "role",
},
)
if err != nil {
panic(err.Error())
}
Get conversation messages
Retrieve messages for a specific conversation, including tool calls made by the assistant.
GET /ai/conversations/{conversation_id}/messages
messages, err := client.AI.Conversations.Messages.List(context.TODO(), "conversation_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messages.Data)
Get Tasks by Status
Retrieve tasks for the user that are either queued, processing, failed, success or partial_success based on the query string.
GET /ai/embeddings
embeddings, err := client.AI.Embeddings.List(context.TODO(), telnyx.AIEmbeddingListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", embeddings.Data)
Embed documents
Perform embedding on a Telnyx Storage Bucket using an embedding model.
POST /ai/embeddings â Required: bucket_name
Optional: document_chunk_overlap_size (integer), document_chunk_size (integer), embedding_model (object), loader (object)
embeddingResponse, err := client.AI.Embeddings.New(context.TODO(), telnyx.AIEmbeddingNewParams{
BucketName: "bucket_name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", embeddingResponse.Data)
List embedded buckets
Get all embedding buckets for a user.
GET /ai/embeddings/buckets
buckets, err := client.AI.Embeddings.Buckets.List(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", buckets.Data)
Get file-level embedding statuses for a bucket
Get all embedded files for a given user bucket, including their processing status.
GET /ai/embeddings/buckets/{bucket_name}
bucket, err := client.AI.Embeddings.Buckets.Get(context.TODO(), "bucket_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", bucket.Data)
Disable AI for an Embedded Bucket
Deletes an entire bucket’s embeddings and disables the bucket for AI-use, returning it to normal storage pricing.
DELETE /ai/embeddings/buckets/{bucket_name}
err := client.AI.Embeddings.Buckets.Delete(context.TODO(), "bucket_name")
if err != nil {
panic(err.Error())
}
Search for documents
Perform a similarity search on a Telnyx Storage Bucket, returning the most similar num_docs document chunks to the query.
POST /ai/embeddings/similarity-search â Required: bucket_name, query
Optional: num_of_docs (integer)
response, err := client.AI.Embeddings.SimilaritySearch(context.TODO(), telnyx.AIEmbeddingSimilaritySearchParams{
BucketName: "bucket_name",
Query: "query",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Embed URL content
Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain.
POST /ai/embeddings/url â Required: url, bucket_name
embeddingResponse, err := client.AI.Embeddings.URL(context.TODO(), telnyx.AIEmbeddingURLParams{
BucketName: "bucket_name",
URL: "url",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", embeddingResponse.Data)
Get an embedding task’s status
Check the status of a current embedding task.
GET /ai/embeddings/{task_id}
embedding, err := client.AI.Embeddings.Get(context.TODO(), "task_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", embedding.Data)
List all clusters
GET /ai/clusters
page, err := client.AI.Clusters.List(context.TODO(), telnyx.AIClusterListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Compute new clusters
Starts a background task to compute how the data in an embedded storage bucket is clustered.
POST /ai/clusters â Required: bucket
Optional: files (array[string]), min_cluster_size (integer), min_subcluster_size (integer), prefix (string)
response, err := client.AI.Clusters.Compute(context.TODO(), telnyx.AIClusterComputeParams{
Bucket: "bucket",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Fetch a cluster
GET /ai/clusters/{task_id}
cluster, err := client.AI.Clusters.Get(
context.TODO(),
"task_id",
telnyx.AIClusterGetParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cluster.Data)
Delete a cluster
DELETE /ai/clusters/{task_id}
err := client.AI.Clusters.Delete(context.TODO(), "task_id")
if err != nil {
panic(err.Error())
}
Fetch a cluster visualization
GET /ai/clusters/{task_id}/graph
response, err := client.AI.Clusters.FetchGraph(
context.TODO(),
"task_id",
telnyx.AIClusterFetchGraphParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
Transcribe speech to text
Transcribe speech to text.
POST /ai/audio/transcriptions
response, err := client.AI.Audio.Transcribe(context.TODO(), telnyx.AIAudioTranscribeParams{
Model: telnyx.AIAudioTranscribeParamsModelDistilWhisperDistilLargeV2,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Text)
Create a chat completion
Chat with a language model.
POST /ai/chat/completions â Required: messages
Optional: api_key_ref (string), best_of (integer), early_stopping (boolean), frequency_penalty (number), guided_choice (array[string]), guided_json (object), guided_regex (string), length_penalty (number), logprobs (boolean), max_tokens (integer), min_p (number), model (string), n (number), presence_penalty (number), response_format (object), stream (boolean), temperature (number), tool_choice (enum), tools (array[object]), top_logprobs (integer), top_p (number), use_beam_search (boolean)
response, err := client.AI.Chat.NewCompletion(context.TODO(), telnyx.AIChatNewCompletionParams{
Messages: []telnyx.AIChatNewCompletionParamsMessage{{
Role: "system",
Content: telnyx.AIChatNewCompletionParamsMessageContentUnion{
OfString: telnyx.String("You are a friendly chatbot."),
},
}, {
Role: "user",
Content: telnyx.AIChatNewCompletionParamsMessageContentUnion{
OfString: telnyx.String("Hello, world!"),
},
}},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
List fine tuning jobs
Retrieve a list of all fine tuning jobs created by the user.
GET /ai/fine_tuning/jobs
jobs, err := client.AI.FineTuning.Jobs.List(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", jobs.Data)
Create a fine tuning job
Create a new fine tuning job.
POST /ai/fine_tuning/jobs â Required: model, training_file
Optional: hyperparameters (object), suffix (string)
fineTuningJob, err := client.AI.FineTuning.Jobs.New(context.TODO(), telnyx.AIFineTuningJobNewParams{
Model: "model",
TrainingFile: "training_file",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", fineTuningJob.ID)
Get a fine tuning job
Retrieve a fine tuning job by job_id.
GET /ai/fine_tuning/jobs/{job_id}
fineTuningJob, err := client.AI.FineTuning.Jobs.Get(context.TODO(), "job_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", fineTuningJob.ID)
Cancel a fine tuning job
Cancel a fine tuning job.
POST /ai/fine_tuning/jobs/{job_id}/cancel
fineTuningJob, err := client.AI.FineTuning.Jobs.Cancel(context.TODO(), "job_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", fineTuningJob.ID)
Create embeddings
Creates an embedding vector representing the input text.
POST /ai/openai/embeddings â Required: input, model
Optional: dimensions (integer), encoding_format (enum), user (string)
response, err := client.AI.OpenAI.Embeddings.NewEmbeddings(context.TODO(), telnyx.AIOpenAIEmbeddingNewEmbeddingsParams{
Input: telnyx.AIOpenAIEmbeddingNewEmbeddingsParamsInputUnion{
OfString: telnyx.String("The quick brown fox jumps over the lazy dog"),
},
Model: "thenlper/gte-large",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
List embedding models
Returns a list of available embedding models.
GET /ai/openai/embeddings/models
response, err := client.AI.OpenAI.Embeddings.ListEmbeddingModels(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Get available models
This endpoint returns a list of Open Source and OpenAI models that are available for use.
GET /ai/models
response, err := client.AI.GetModels(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Summarize file content
Generate a summary of a file’s contents.
POST /ai/summarize â Required: bucket, filename
Optional: system_prompt (string)
response, err := client.AI.Summarize(context.TODO(), telnyx.AISummarizeParams{
Bucket: "bucket",
Filename: "filename",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)