-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #200 from stackql/feature/doc-updates
added anthropic
- Loading branch information
Showing
14 changed files
with
277 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,7 @@ const allProviders = [ | |
| 'firebase', | ||
| 'github', | ||
| 'openai', | ||
| 'anthropic', | ||
| 'google', | ||
| 'googleadmin', | ||
| 'k8s', | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| title: anthropic | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - anthropic | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Anthropic resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/anthropic/stackql-anthropic-provider-featured-image.png | ||
| id: anthropic-doc | ||
| slug: /providers/anthropic | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
| AI models including Claude for advanced language understanding and generation. | ||
|
|
||
| :::info Provider Summary (v24.10.00267) | ||
|
|
||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <span>total services: <b>1</b></span><br /> | ||
| <span>total methods: <b>2</b></span><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| <span>total resources: <b>2</b></span><br /> | ||
| <span>total selectable resources: <b>2</b></span><br /> | ||
| </div> | ||
| </div> | ||
|
|
||
| ::: | ||
|
|
||
| See also: | ||
| [[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) | ||
| * * * | ||
|
|
||
| ## Installation | ||
|
|
||
| To pull the latest version of the `anthropic` provider, run the following command: | ||
|
|
||
| ```bash | ||
| REGISTRY PULL anthropic; | ||
| ``` | ||
| > To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). | ||
| ## Authentication | ||
|
|
||
| The following system environment variables are used for authentication by default: | ||
|
|
||
| - <CopyableCode code="ANTHROPIC_API_KEY" /> - Anthropic API key (see <a href="https://docs.anthropic.com/claude/reference/getting-started-with-the-api">How to Create an Anthropic API Key</a>) | ||
|
|
||
| These variables are sourced at runtime (from the local machine or as CI variables/secrets). | ||
|
|
||
| <details> | ||
|
|
||
| <summary>Using different environment variables</summary> | ||
|
|
||
| To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: | ||
|
|
||
| ```bash | ||
|
|
||
| AUTH='{ "anthropic": { "type": "bearer", "credentialsenvvar": "MY_ANTHROPIC_API_KEY" }}' | ||
| stackql shell --auth="${AUTH}" | ||
|
|
||
| ``` | ||
| or using PowerShell: | ||
|
|
||
| ```powershell | ||
| $Auth = "{ 'anthropic': { 'type': 'bearer', 'credentialsenvvar': 'MY_ANTHROPIC_API_KEY' }}" | ||
| stackql.exe shell --auth=$Auth | ||
| ``` | ||
| </details> | ||
|
|
||
| ## Services | ||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/anthropic/messages/">messages</a><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| </div> | ||
| </div> |
43 changes: 43 additions & 0 deletions
43
docs/anthropic-docs/providers/anthropic/messages/claude_35_chat/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: claude_35_chat | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - claude_35_chat | ||
| - messages | ||
| - anthropic | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Anthropic resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/anthropic/stackql-anthropic-provider-featured-image.png | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>claude_35_chat</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="anthropic.messages.claude_35_chat" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| > This resource is a view. For the view definition, please refer to the provider spec in the [stackql-provider-registry](https://github.com/stackql/stackql-provider-registry/blob/dev/providers/src/anthropic/v00.00.00000/services/messages.yaml), located under `components -> x-stackQL-resources -> claude_35_chat`. | ||
| | Name | Datatype | | ||
| |:-----|:---------| | ||
| | <CopyableCode code="content" /> || | ||
| | <CopyableCode code="input_tokens" /> | `text` | | ||
| | <CopyableCode code="model" /> | `text` | | ||
| | <CopyableCode code="output_tokens" /> | `text` | | ||
| | <CopyableCode code="role" /> | `text` | | ||
| | <CopyableCode code="stop_reason" /> | `text` | | ||
| | <CopyableCode code="stop_sequence" /> | `text` | | ||
| ## Methods | ||
| No additional methods available for this resource |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: messages | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - messages | ||
| - anthropic | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Anthropic resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/anthropic/stackql-anthropic-provider-featured-image.png | ||
| --- | ||
|
|
||
| Given A List Of Messages Comprising A Conversation, The Model Will Return A Response. | ||
|
|
||
| :::info Service Summary | ||
|
|
||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <span>total resources: <b>2</b></span><br /> | ||
| <span>total selectable resources: <b>2</b></span><br /> | ||
| <span>total methods: <b>2</b></span><br /> | ||
| </div> | ||
| </div> | ||
|
|
||
| ::: | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>anthropic.messages</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Service</td></tr> | ||
| <tr><td><b>Title</b></td><td>Anthropic API - Messages</td></tr> | ||
| <tr><td><b>Description</b></td><td>Given A List Of Messages Comprising A Conversation, The Model Will Return A Response.</td></tr> | ||
| <tr><td><b>Id</b></td><td><code>messages:v24.10.00267</code></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Resources | ||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/anthropic/messages/claude_35_chat/">claude_35_chat</a><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/anthropic/messages/message/">message</a><br /> | ||
| </div> | ||
| </div> |
44 changes: 44 additions & 0 deletions
44
docs/anthropic-docs/providers/anthropic/messages/message/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: message | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - message | ||
| - messages | ||
| - anthropic | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Anthropic resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/anthropic/stackql-anthropic-provider-featured-image.png | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>message</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="anthropic.messages.message" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| | Name | Datatype | Description | | ||
| |:-----|:---------|:------------| | ||
| | <CopyableCode code="id" /> | `string` | Unique object identifier. | | ||
| | <CopyableCode code="content" /> | `array` | The generated content blocks by the model. | | ||
| | <CopyableCode code="model" /> | `string` | The model that handled the request. | | ||
| | <CopyableCode code="role" /> | `string` | The conversational role of the generated message. | | ||
| | <CopyableCode code="stop_reason" /> | `string` | The reason the model stopped generating. | | ||
| | <CopyableCode code="stop_sequence" /> | `string` | The stop sequence that caused the model to stop, if applicable. | | ||
| | <CopyableCode code="type" /> | `string` | Object type, which is always "message" for Messages API. | | ||
| | <CopyableCode code="usage" /> | `object` | Information about token usage and rate limits. | | ||
| ## Methods | ||
| | Name | Accessible by | Required Params | | ||
| |:-----|:--------------|:----------------| | ||
| | <CopyableCode code="create_message" /> | `SELECT` | <CopyableCode code="anthropic-version, data__max_tokens, data__messages, data__model" /> | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: StackQL Provider Registry | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| keywords: | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query and Deploy Cloud Infrastructure and Resources using SQL | ||
| custom_edit_url: null | ||
| image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png | ||
| slug: / | ||
| --- | ||
| import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; | ||
|
|
||
| <RegistryPage currentProvider="anthropic" /> | ||
|
|
||
| --- | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+35.3 KB
static/img/providers/anthropic/stackql-anthropic-provider-featured-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.