telnyx-ai-inference-go

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Ai Inference - Go ## Installation ```bash go get github.com/team-telnyx/telnyx-go ``` ## Setup ```go 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` ```go 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` ```go 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` ```go 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` ```go 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}` ```go 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}` ```go 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}` ```go 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` ```go 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` ```go 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` ```go 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` ```go 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}` ```go 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}` ```go 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}` ```go 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}` ```go 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}` ```go 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}` ```go 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` ```go 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` ```go 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` ```go 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` ```go 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` ```go 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` ```go 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}` ```go 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}` ```go 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` ```go 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` ```go 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}`